Support property, property-read and property-write tags

Author: GrahamCampbell

Symfony/CS/AbstractPhpdocTypesFixer.php

@@ -27,7 +27,7 @@ abstract class AbstractPhpdocTypesFixer extends AbstractFixer
      *
      * @var string[]
      */
-    protected static $tags = array('param', 'return', 'type', 'var', 'property');
+    protected static $tags = array('param', 'property', 'property-read', 'property-write', 'return', 'type', 'var');
 
     /**
      * {@inheritdoc}

Symfony/CS/DocBlock/Tag.php

@@ -26,8 +26,9 @@ class Tag
     private static $tags = array(
         'api', 'author', 'category', 'copyright', 'deprecated', 'example',
         'global', 'internal', 'license', 'link', 'method', 'package', 'param',
-        'property', 'return', 'see', 'since', 'struct', 'subpackage', 'throws',
-        'todo', 'typedef', 'uses', 'var', 'version',
+        'property', 'property-read', 'property-write', 'return', 'see',
+        'since', 'struct', 'subpackage', 'throws', 'todo', 'typedef', 'uses',
+        'var', 'version',
     );
 
     /**
@@ -45,7 +46,7 @@ class Tag
     public function __construct($content)
     {
         $this->name = 'other';
-        preg_match_all('/@[a-zA-Z0-9_]+(?=\s|$)/', $content, $matches);
+        preg_match_all('/@[a-zA-Z0-9_-]+(?=\s|$)/', $content, $matches);
 
         if (isset($matches[0][0])) {
             $this->name = ltrim($matches[0][0], '@');

Symfony/CS/DocBlock/TagComparator.php

@@ -28,6 +28,7 @@ class TagComparator
         array('deprecated', 'link', 'see', 'since'),
         array('author', 'copyright', 'license'),
         array('package', 'subpackage'),
+        array('property', 'property-read', 'property-write'),
     );
 
     /**

Symfony/CS/Tests/DocBlock/TagTest.php

@@ -37,6 +37,7 @@ public function provideNameCases()
             array('THROWSSS', "\t@THROWSSS\t  \t RUNTIMEEEEeXCEPTION\t\t\t\t\t\t\t\n\n\n"),
             array('other', ' *   @\Foo\Bar(baz = 123)'),
             array('expectedException', '     * @expectedException Exception'),
+            array('property-read', ' * @property-read integer $daysInMonth number of days in the given month'),
             array('method', ' * @method'),
             array('method', ' * @method string getString()'),
             array('other', ' * @method("GET")'),
@@ -61,6 +62,7 @@ public function provideValidCases()
             array(true, '*@throws \Exception'),
             array(true, ' * @method'),
             array(true, ' * @method string getString()'),
+            array(true, ' * @property-read integer $daysInMonth number of days in the given month'),
             array(false, ' * @method("GET")'),
             array(false, '*@thRoWs \InvalidArgumentException'),
             array(false, "\t@THROWSSS\t  \t RUNTIMEEEEeXCEPTION\t\t\t\t\t\t\t\n\n\n"),

Symfony/CS/Tests/Fixer/Symfony/PhpdocScalarFixerTest.php

@@ -45,6 +45,8 @@ public function testPropertyFix()
 <?php
 /**
  * @property int $foo
+ * @property-read bool $bar
+ * @property-write float $baz
  */
 
 EOF;
@@ -53,6 +55,8 @@ public function testPropertyFix()
 <?php
 /**
  * @property integer $foo
+ * @property-read boolean $bar
+ * @property-write double $baz
  */
 
 EOF;

Symfony/CS/Tests/Fixer/Symfony/PhpdocSeparationFixerTest.php

@@ -343,6 +343,36 @@ public function testDeprecatedAndSeeTags()
      * @return void
      */
 
+EOF;
+
+        $this->makeTest($expected, $input);
+    }
+
+    public function testPropertyTags()
+    {
+        $expected = <<<'EOF'
+<?php
+    /**
+     * @author Bar Baz <[email protected]>
+     *
+     * @property int $foo
+     * @property-read int $foo
+     * @property-write int $bar
+     */
+
+EOF;
+
+        $input = <<<'EOF'
+<?php
+    /**
+     * @author Bar Baz <[email protected]>
+     * @property int $foo
+     *
+     * @property-read int $foo
+     *
+     * @property-write int $bar
+     */
+
 EOF;
 
         $this->makeTest($expected, $input);

Symfony/CS/Tests/Fixer/Symfony/PhpdocTypesFixerTest.php

@@ -90,6 +90,31 @@ public function testMixedAndVoid()
         $this->makeTest($expected, $input);
     }
 
+    public function testPropertyFix()
+    {
+        $expected = <<<'EOF'
+<?php
+/**
+ * @property int $foo
+ * @property-read boolean $bar
+ * @property-write mixed $baz
+ */
+
+EOF;
+
+        $input = <<<'EOF'
+<?php
+/**
+ * @property Int $foo
+ * @property-read Boolean $bar
+ * @property-write MIXED $baz
+ */
+
+EOF;
+
+        $this->makeTest($expected, $input);
+    }
+
     public function testInlineDoc()
     {
         $expected = <<<'EOF'