Merge cce5380 into a5af856

docs/references/phpdoc/tags/method.rst

@@ -6,13 +6,13 @@ The @method allows a class to know which 'magic' methods are callable.
 Syntax
 ------
 
-    @method [return type] [name]([[type] [parameter]<, ...>]) [<description>]
+    @method [[static] return type] [name]([[type] [parameter]<, ...>]) [<description>]
 
 Description
 -----------
 
 The @method tag is used in situation where a class contains the ``__call()``
-magic method and defines some definite uses.
+or ``__callStatic()`` magic method and defines some definite uses.
 
 An example of this is a child class whose parent has a __call() to have dynamic
 getters or setters for predefined properties. The child knows which getters and
@@ -26,6 +26,11 @@ return value by including those types in the signature.
 When the intended method does not have a return value then the return type MAY
 be omitted; in which case 'void' is implied.
 
+If the intended method is static, the ``static`` keyword can be placed before
+the return type to communicate that.
+There must be a return type, ``static`` on its own would mean that the method
+returns an instance of the child class which the method is called on.
+
 @method tags MUST NOT be used in a :term:`PHPDoc` that is not associated with
 a *class* or *interface*.
 
@@ -54,6 +59,7 @@ Examples
      * @method string getString()
      * @method void setInteger(integer $integer)
      * @method setString(integer $integer)
+     * @method static string staticGetter()
      */
     class Child extends Parent
     {

src/phpDocumentor/Descriptor/Builder/Reflector/Tags/MethodAssembler.php

@@ -38,6 +38,7 @@ public function create($data)
         $descriptor = new MethodDescriptor($data->getName());
         $descriptor->setDescription($data->getDescription());
         $descriptor->setMethodName($data->getMethodName());
+        $descriptor->setStatic($data->isStatic());
 
         $response = new ReturnDescriptor('return');
         $response->setTypes($this->builder->buildDescriptor(new Collection($data->getTypes())));

src/phpDocumentor/Descriptor/ClassDescriptor.php

@@ -203,6 +203,7 @@ public function getMagicMethods()
             $method = new MethodDescriptor();
             $method->setName($methodTag->getMethodName());
             $method->setDescription($methodTag->getDescription());
+            $method->setStatic($methodTag->isStatic());
             $method->setParent($this);
 
             $returnTags = $method->getTags()->get('return', new Collection());

src/phpDocumentor/Descriptor/Tag/MethodDescriptor.php

@@ -22,6 +22,9 @@ class MethodDescriptor extends TagDescriptor
 
     protected $response;
 
+    /** @var bool */
+    protected $static;
+
     public function __construct($name)
     {
         parent::__construct($name);
@@ -76,4 +79,20 @@ public function getResponse()
     {
         return $this->response;
     }
+
+    /**
+     * @param bool $static
+     */
+    public function setStatic($static)
+    {
+        $this->static = $static;
+    }
+
+    /**
+     * @return bool
+     */
+    public function isStatic()
+    {
+        return $this->static;
+    }
 }

src/phpDocumentor/Descriptor/TraitDescriptor.php

@@ -76,6 +76,7 @@ public function getMagicMethods()
             $method = new MethodDescriptor();
             $method->setName($methodTag->getMethodName());
             $method->setDescription($methodTag->getDescription());
+            $method->setStatic($methodTag->isStatic());
             $method->setParent($this);
 
             $methods->add($method);

tests/ReferenceImplementation.php

@@ -73,6 +73,7 @@ class SubClass extends SuperClass
      * @author Mike van Riel <mike.vanriel@naenius.com>
      * @package Class
      * @method string myMagicMethod(\stdClass $argument1) This is a description.
+     * @method static string myStaticMagicMethod(\stdClass $argument1) This is a description.
      * @property string $myMagicProperty This is a description.
      */
     class SuperClass implements SubInterface

tests/unit/phpDocumentor/Descriptor/ClassDescriptorTest.php

@@ -377,6 +377,7 @@ public function testGetMagicMethods()
         $methodMock->shouldReceive('getDescription')->andReturn($description);
         $methodMock->shouldReceive('getResponse')->andReturn($response);
         $methodMock->shouldReceive('getArguments')->andReturn($arguments);
+        $methodMock->shouldReceive('isStatic')->andReturn(true);
 
         $this->fixture->getTags()->get('method', new Collection())->add($methodMock);
 
@@ -389,6 +390,7 @@ public function testGetMagicMethods()
         $this->assertEquals($methodName, $magicMethod->getName());
         $this->assertEquals($description, $magicMethod->getDescription());
         $this->assertEquals($response, $magicMethod->getResponse());
+        $this->assertEquals(true, $magicMethod->isStatic());
 
         $mock = m::mock('phpDocumentor\Descriptor\ClassDescriptor');
         $mock->shouldReceive('getMagicMethods')->andReturn(new Collection(array('magicMethods')));

tests/unit/phpDocumentor/Descriptor/TraitDescriptorTest.php

@@ -101,6 +101,7 @@ public function testMagicMethodsReturnsExpectedCollectionWithTags()
     {
         $mockMethodDescriptor = m::mock('phpDocumentor\Descriptor\Tag\MethodDescriptor');
         $mockMethodDescriptor->shouldReceive('getMethodName')->andReturn('Sample');
+        $mockMethodDescriptor->shouldReceive('isStatic')->andReturn(false);
         $mockMethodDescriptor->shouldReceive('getDescription')->andReturn('Sample description');
 
         $methodCollection = new Collection(array($mockMethodDescriptor));
@@ -111,6 +112,7 @@ public function testMagicMethodsReturnsExpectedCollectionWithTags()
         $this->assertSame(1, $magicMethodsCollection->count());
         $this->assertSame('Sample', $magicMethodsCollection[0]->getName());
         $this->assertSame('Sample description', $magicMethodsCollection[0]->getDescription());
+        $this->assertSame(false, $magicMethodsCollection[0]->isStatic());
         $this->assertSame($this->fixture, $magicMethodsCollection[0]->getParent());
     }