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

Timestamp:

02/25/2016 10:49:24 PM (10 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-plugin-geopattern.php (modified) (5 diffs)

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

@@ -7 +7 @@
  * Generates Geopattern icons for Plugins.
  *
- * @package WordPressdotorg_Plugin_Directory
+ * @package WordPressdotorg\Plugin_Directory
  */
 class Plugin_Geopattern extends \RedeyeVentures\GeoPattern\GeoPattern {
 
-        var $slug; // Hashed to generate pattern
-        var $text; // Text to be overlaid
-        var $textcolor = 'black';
+        /**
+         * Hashed to generate pattern.
+         *
+         * @var string
+         */
+        public $slug;
 
-        function __construct($options=array()) {
+        /**
+         * Text to be overlaid.
+         *
+         * @var string
+         */
+        public $text;
+
+        /**
+         * @var string
+         */
+        public $textcolor = 'black';
+
+        /**
+         * @param array $options
+         */
+        function __construct( $options = array() ) {
                 parent::__construct( $options );
 
-                if ( isset( $options['text'] ) )
+                if ( isset( $options['text'] ) ) {
                         $this->text = $options['text'];
+                }
 
-                if ( isset( $options['textcolor'] ) )
+                if ( isset( $options['textcolor'] ) ) {
                         $this->textcolor = $options['textcolor'];
+                }
 
                 // Replace the base SVG object with our own, so the dimensions are gettable.
@@ -28 +48 @@
         }
 
+        /**
+         * @param $text
+         */
         function setText( $text ) {
                 $this->text = $text;
         }
 
+        /**
+         * @param $color
+         */
         function setTextColor( $color ) {
                 $this->textcolor = $color;
         }
 
+        /**
+         *
+         */
         function generateText() {
-                $size = min( $this->svg->getHeight(), $this->svg->getWidth() );
+                $size        = min( $this->svg->getHeight(), $this->svg->getWidth() );
                 $text_height = floor( $size * 0.8 ) . 'px';
 
@@ -43 +72 @@
         }
 
+        /**
+         * @param int $width
+         * @param int $height
+         * @return string
+         */
         public function toSVG( $width = 128, $height = 128 ) {
                 $this->svg = new Plugin_Geopattern_SVG();
                 $this->generateBackground();
 
-                // Work around a bug in 1.1.0: the hash-based pattern selection doesn't account for the size of the pattern array and can choose a null result.
-                $this->setGenerator( $this->patterns[$this->hexVal(20, 1) % count( $this->patterns )] );
+                /*
+                 * Work around a bug in 1.1.0:
+                 * The hash-based pattern selection doesn't account for the size of the
+                 * pattern array and can choose a null result.
+                 */
+                $this->setGenerator( $this->patterns[ $this->hexVal( 20, 1 ) % count( $this->patterns ) ] );
 
                 $this->generatePattern();
@@ -59 +97 @@
                         $inner = $this->svg;
 
-                        // Outer SVG, containing the text and nested inner SVG.
-                        // Needed because of aspect ratio problems with the background pattern. The outer is square, inner may be a different shape.
+                        /*
+                         * Outer SVG, containing the text and nested inner SVG.
+                         *
+                         * Needed because of aspect ratio problems with the background pattern.
+                         * The outer is square, inner may be a different shape.
+                         */
                         $this->svg = new PluginSVG();
                         $this->svg->setWidth( $width );
@@ -69 +111 @@
 
                 return $this->svg->getString();
-
-    }
-
-}
-
-// The base SVG class doesn't provide functions for getting dimensions, so..
-class Plugin_Geopattern_SVG extends \RedeyeVentures\GeoPattern\SVG {
-
-        protected $viewbox;
-
-        function getWidth() {
-                return $this->width;
-        }
-
-        function getHeight() {
-                return $this->height;
-        }
-
-    protected function getSvgHeader() {
-                if ( $this->viewbox )
-                        return "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"{$this->width}\" height=\"{$this->height}\" viewbox=\"{$this->viewbox}\" preserveAspectRatio=\"none\">";
-                else
-                        return "<svg xmlns=\"http://www.w3.org/2000/svg\" width=\"{$this->width}\" height=\"{$this->height}\">";
-    }
-
-    public function addText( $text, $x, $y, $text_anchor, $style, $args=array() ) {
-        $element = new Plugin_Geopattern_SVGText($text, $x, $y, $text_anchor, $style, $args);
-        $this->svgString .= $element;
-        return $this;
-        }
-
-        public function addNested( $svg ) {
-                if ( method_exists( $svg, 'getString' ) )
-                        $this->svgString .= $svg->getString();
-        }
-
-        public function setViewBox( $x, $y, $w, $h ) {
-                $this->viewbox = esc_attr( "$x $y $w $h" );
-        }
-
-}
-
-// Nor does it support text.
-class Plugin_Geopattern_SVGText extends \RedeyeVentures\GeoPattern\SVGElements\Base {
-        protected $tag = 'text';
-        protected $text;
-
-        function __construct($text, $x, $y, $text_anchor, $style, $args=array()) {
-                $this->elements = array( 
-                        'x' => $x,
-                        'y' => $y,
-                        'text-anchor' => $text_anchor,
-                        'style' => $style,
-                        );
-                $this->text = esc_html( $text );
-                parent::__construct($args);
-        }
-
-        public function getString() {
-                return "<{$this->tag}{$this->elementsToString()}{$this->argsToString()}>{$this->text}</{$this->tag}>";
         }
 }
-