Rewritten Property tag and added test

2026-08-18 10:07:12 +00:00 · 2015-06-21 08:47:34 +02:00
parent d1f4ee3c03
commit a7a4d3ff69
2 changed files with 303 additions and 5 deletions
@@ -1,20 +1,118 @@
 <?php
 /**
- * phpDocumentor
+ * This file is part of phpDocumentor.
 *
- * PHP Version 5.3
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
 *
- * @author    Mike van Riel <mike[email protected]>
- * @copyright 2010-2011 Mike van Riel / Naenius (http://www.naenius.com)
+ * @copyright 2010-2015 Mike van Riel<mike@phpdoc.org>
 * @license   http://www.opensource.org/licenses/mit-license.php MIT
 * @link      http://phpdoc.org
 */

 namespace phpDocumentor\Reflection\DocBlock\Tags;

+use phpDocumentor\Reflection\DocBlock\Description;
+use phpDocumentor\Reflection\DocBlock\DescriptionFactory;
+use phpDocumentor\Reflection\Type;
+use phpDocumentor\Reflection\TypeResolver;
+use phpDocumentor\Reflection\Types\Context;
+use Webmozart\Assert\Assert;
+
 /**
- * Reflection class for a @property tag in a Docblock.
+ * Reflection class for a {@}property tag in a Docblock.
 */
 class Property extends Param
 {
+    /** @var string */
+    protected $name = 'property';
+
+    /** @var Type */
+    private $type;
+
+    /** @var string */
+    protected $variableName = '';
+
+    /**
+     * @param string      $variableName
+     * @param Type        $type
+     * @param Description $description
+     */
+    public function __construct($variableName, Type $type = null, Description $description = null)
+    {
+        Assert::string($variableName);
+
+        $this->variableName = $variableName;
+        $this->type = $type;
+        $this->description = $description;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public static function create(
+        $body,
+        TypeResolver $typeResolver = null,
+        DescriptionFactory $descriptionFactory = null,
+        Context $context = null
+    ) {
+        Assert::stringNotEmpty($body);
+        Assert::allNotNull([$typeResolver, $descriptionFactory]);
+
+        $parts = preg_split('/(\s+)/Su', $body, 3, PREG_SPLIT_DELIM_CAPTURE);
+        $type = null;
+        $variableName = '';
+
+        // if the first item that is encountered is not a variable; it is a type
+        if (isset($parts[0]) && (strlen($parts[0]) > 0) && ($parts[0][0] !== '$')) {
+            $type = $typeResolver->resolve(array_shift($parts), $context);
+            array_shift($parts);
+        }
+
+        // if the next item starts with a $ or ...$ it must be the variable name
+        if (isset($parts[0]) && (strlen($parts[0]) > 0) && ($parts[0][0] == '$')) {
+            $variableName = array_shift($parts);
+            array_shift($parts);
+
+            if (substr($variableName, 0, 1) === '$') {
+                $variableName = substr($variableName, 1);
+            }
+        }
+
+        $description = $descriptionFactory->create(implode('', $parts), $context);
+
+        return new static($variableName, $type, $description);
+    }
+
+    /**
+     * Returns the variable's name.
+     *
+     * @return string
+     */
+    public function getVariableName()
+    {
+        return $this->variableName;
+    }
+
+    /**
+     * Returns the variable's type or null if unknown.
+     *
+     * @return Type|null
+     */
+    public function getType()
+    {
+        return $this->type;
+    }
+
+    /**
+     * Returns a string representation for this tag.
+     *
+     * @return string
+     */
+    public function __toString()
+    {
+        return ($this->type ? $this->type . ' ' : '')
+        . '$' . $this->variableName
+        . ($this->description ? ' ' . $this->description : '');
+    }
 }