Changeset 3326

Timestamp:

06/09/2016 10:28:14 PM (10 years ago)

Author:

obenland

Message:

Plugin Directory: Docs cleanup.

For a more at ease IDE.

See #1584.

Location:

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory

Files:

• class-plugin-directory.php (modified) (6 diffs)
• class-plugin-i18n.php (modified) (2 diffs)
• class-readme-parser.php (modified) (1 diff)
• class-template.php (modified) (3 diffs)

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-plugin-directory.php

@@ -359 +359 @@
          * Filter the permalink for terms to be more useful.
          *
-         * @param string   $termlink The generated term link.
-         * @param \WP_Term $term     The term the link is for.
-         */
-        public function term_link( $termlink, $term ) {
+         * @param string   $term_link The generated term link.
+         * @param \WP_Term $term      The term the link is for.
+         * @return string|false
+         */
+        public function term_link( $term_link, $term ) {
                 if ( 'plugin_business_model' == $term->taxonomy ) {
                         return false;
@@ -371 +372 @@
                 }
 
-                return $termlink;
+                return $term_link;
         }
 
@@ -447 +448 @@
          * Returns the requested page's content, translated.
          *
-         * @param string $content
+         * @param string $content Post content.
+         * @param string $section Optional. Which readme section to translate.
          * @return string
          */
@@ -454 +456 @@
                         return $content;
                 }
-                return Plugin_i18n::instance()->translate( $section, $content );
+                return Plugin_I18n::instance()->translate( $section, $content );
         }
 
@@ -460 +462 @@
          * Returns the requested page's content, translated.
          *
-         * @param string $content
+         * @param string $title
+         * @param int    $post_id
          * @return string
          */
         public function translate_post_title( $title, $post_id ) {
                 if ( $post_id === get_post()->ID ) {
-                        return Plugin_i18n::instance()->translate( 'title', $title );
+                        return Plugin_I18n::instance()->translate( 'title', $title );
                 }
                 return $title;
@@ -473 +476 @@
          * Returns the requested page's excerpt, translated.
          *
-         * @param string $content
+         * @param string $excerpt
          * @return string
          */
         public function translate_post_excerpt( $excerpt ) {
-                return Plugin_i18n::instance()->translate( 'excerpt', $excerpt );
+                return Plugin_I18n::instance()->translate( 'excerpt', $excerpt );
         }
 

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-plugin-i18n.php

@@ -12 +12 @@
          * @var string Global cache group for related caching
          */
-        var $i18n_cache_group = 'plugins-i18n';
+        public $i18n_cache_group = 'plugins-i18n';
+
+        public $master_project;
 
         public static $use_cache = true;
         public static $set_cache = true;
+
+        /**
+         * @var \wpdb WordPress database abstraction object.
+         */
+        protected $db;
 
         /**
@@ -75 +82 @@
 
         /**
-         * Cache setting, with proper global cache group
-         *
-         * @param string $slug Plugin slug
-         * @param string $branch dev|stable
-         * @param string $suffix Arbitrary cache key suffix, if needed for uniqueness
+         * Cache setting, with proper global cache group.
+         *
+         * @param string $slug    Plugin slug
+         * @param string $branch  dev|stable
+         * @param mixed  $content Content to be cached.
+         * @param string $suffix  Optional. Arbitrary cache key suffix, if needed for uniqueness.
          *
          * @return bool As returned by wp_cache_set()

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-readme-parser.php

@@ -1 +1 @@
 <?php
 namespace WordPressdotorg\Plugin_Directory;
-use WordPressdotorg\Plugin_Directory\Markdown;
 
 /**

sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-template.php

@@ -12 +12 @@
          * Returns a string representing the number of active installs for an item.
          *
-         * @param bool $full whether to include "actuve installs" suffix. Default: true.
-         * @return string "1+ million" or "1+ milllion active installs" depending on $full.
+         * @param bool              $full Whether to include "active installs" suffix. Default: true.
+         * @param int|\WP_Post|null $post Optional. Post ID or post object. Defaults to global $post.
+         * @return string "1+ million" or "1+ million active installs" depending on $full.
          */
         static function active_installs( $full = true, $post = null ) {
@@ -67 +68 @@
          * Displays a plugin's rating with the amount of ratings it has received.
          *
-         * @param \WP_Post|int $post
+         * @param int|\WP_Post|null $post Optional. Post ID or post object. Defaults to global $post.
          * @return string
          */
-        public static function get_star_rating( $post = 0 ) {
+        public static function get_star_rating( $post = null ) {
                 $post = get_post( $post );
 
@@ -86 +87 @@
 
         /**
+         * @param int|\WP_Post|null $post Optional. Post ID or post object. Defaults to global $post.
          * @return array
          */