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

Timestamp:

02/25/2016 10:49:24 PM (11 years ago)

Author:

obenland

Message:

Plugins Directory: Formatting update.

• Updates phpdocs throughout the plugin.
• Breaks out classes into their own files.
• Some minor namespace-related tweaks.

See #1584.

File:

• sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-template.php (modified) (10 diffs)

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

@@ -5 +5 @@
  * Various helpers to retrieve data not stored within WordPress.
  *
- * @package WordPressdotorg_Plugin_Directory
+ * @package WordPressdotorg\Plugin_Directory
  */
 class Template {
@@ -53 +53 @@
          */
         static function get_plugin_sections() {
-                $plugin       = get_post();
-                $plugin_slug  = $plugin->post_name;
+                $plugin      = get_post();
+                $plugin_slug = $plugin->post_name;
 
                 $default_sections = array(
@@ -71 +71 @@
                 $raw_sections = array_unique( array_merge( $raw_sections, $default_sections ) );
 
-                $sections  = array();
-                $title     = '';
-                $permalink = get_permalink();
+                $sections     = array();
+                $title = $url = '';
+                $permalink    = get_permalink();
 
                 foreach ( $raw_sections as $section_slug ) {
@@ -145 +145 @@
          * Retrieve the Plugin Icon details for a plugin.
          *
-         * @param WP_Post|string $plugin An instance of a Plugin post, or the plugin slug.
+         * @param \WP_Post|string $plugin An instance of a Plugin post, or the plugin slug.
          * @return mixed
          */
@@ -163 +163 @@
                                         $icon_2x = self::get_asset_url( $plugin_slug, $info );
                                         break;
+
                                 case '128x128':
                                         $icon = self::get_asset_url( $plugin_slug, $info );
                                         break;
+
                                 case false && 'icon.svg' == $file:
-                                        $icon = self::get_asset_url( $plugin_slug, $info );
+                                        $icon   = self::get_asset_url( $plugin_slug, $info );
                                         $vector = true;
                                         break;
@@ -191 +193 @@
                 switch ( $output ) {
                         case 'html':
-                                $id = "plugin-icon-{$plugin_slug}";
+                                $id   = "plugin-icon-{$plugin_slug}";
                                 $html = "<style type='text/css'>";
                                 $html .= "#{$id} { width:128px; height:128px; background-image: url('{$icon}'); background-size:128px 128px; }";
@@ -202 +204 @@
                                 return $html;
                                 break;
+
                         case 'raw':
                         default:
@@ -211 +214 @@
          * Retrieve the Plugin Icon details for a plugin.
          *
-         * @param WP_Post|string $plugin An instance of a Plugin post, or the plugin slug.
+         * @param \WP_Post|string $plugin An instance of a Plugin post, or the plugin slug.
          * @return mixed
          */
@@ -229 +232 @@
                                         $banner_2x = self::get_asset_url( $plugin_slug, $info );
                                         break;
+
                                 case '772x250':
                                         $banner = self::get_asset_url( $plugin_slug, $info );
@@ -246 +250 @@
         }
 
+        /**
+         * @param $plugin
+         * @param $asset
+         * @return string
+         */
         static function get_asset_url( $plugin, $asset ) {
                 if ( ! empty( $asset['location'] ) && 'plugin' == $asset['location'] ) {