Completed
Push — develop ( 0b8425...c51867 )
by Jaap
15s queued 11s
created

Builder/Reflector/Tags/MethodAssembler.php (1 issue)

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

1
<?php
2
declare(strict_types=1);
3
4
/**
5
 * This file is part of phpDocumentor.
6
 *
7
 * For the full copyright and license information, please view the LICENSE
8
 * file that was distributed with this source code.
9
 *
10
 * @author    Mike van Riel <[email protected]>
11
 * @copyright 2010-2018 Mike van Riel / Naenius (http://www.naenius.com)
12
 * @license   http://www.opensource.org/licenses/mit-license.php MIT
13
 * @link      http://phpdoc.org
14
 */
15
16
namespace phpDocumentor\Descriptor\Builder\Reflector\Tags;
17
18
use phpDocumentor\Descriptor\ArgumentDescriptor;
19
use phpDocumentor\Descriptor\Builder\Reflector\AssemblerAbstract;
20
use phpDocumentor\Descriptor\Tag\MethodDescriptor;
21
use phpDocumentor\Descriptor\Tag\ReturnDescriptor;
22
use phpDocumentor\Reflection\DocBlock\Tags\Method;
23
use phpDocumentor\Reflection\Type;
24
25
/**
26
 * Constructs a new descriptor from the Reflector for an `@method` tag.
27
 *
28
 * This object will read the reflected information for the `@method` tag and create a {@see MethodDescriptor} object
29
 * that can be used in the rest of the application and templates.
30
 */
31
class MethodAssembler extends AssemblerAbstract
32
{
33
    /**
34
     * Creates a new Descriptor from the given Reflector.
35
     *
36
     * @param Method $data
37
     *
38
     * @return MethodDescriptor
39
     */
40 6
    public function create($data)
41
    {
42 6
        $descriptor = new MethodDescriptor($data->getName());
43 6
        $descriptor->setDescription($data->getDescription());
44 6
        $descriptor->setMethodName($data->getMethodName());
45 6
        $descriptor->setStatic($data->isStatic());
46
47 6
        $response = new ReturnDescriptor('return');
48 6
        $response->setType($data->getReturnType());
49 6
        $descriptor->setResponse($response);
50
51 6
        foreach ($data->getArguments() as $argument) {
52 5
            $argumentDescriptor = $this->createArgumentDescriptorForMagicMethod($argument['name'], $argument['type']);
53 5
            $descriptor->getArguments()->set($argumentDescriptor->getName(), $argumentDescriptor);
54
        }
55
56 6
        return $descriptor;
0 ignored issues
show
Bug Best Practice introduced by
The return type of return $descriptor; (phpDocumentor\Descriptor\Tag\MethodDescriptor) is incompatible with the return type declared by the interface phpDocumentor\Descriptor...emblerInterface::create of type phpDocumentor\Descriptor...r\Descriptor\Collection.

If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design.

Let’s take a look at an example:

class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}

Our function my_function expects a Post object, and outputs the author of the post. The base class Post returns a simple string and outputting a simple string will work just fine. However, the child class BlogPost which is a sub-type of Post instead decided to return an object, and is therefore violating the SOLID principles. If a BlogPost were passed to my_function, PHP would not complain, but ultimately fail when executing the strtoupper call in its body.

Loading history...
57
    }
58
59
    /**
60
     * Construct an argument descriptor given the array representing an argument with a Method Tag in the Reflection
61
     * component.
62
     */
63 5
    private function createArgumentDescriptorForMagicMethod(string $name, Type $type): ArgumentDescriptor
64
    {
65 5
        $argumentDescriptor = new ArgumentDescriptor();
66 5
        $argumentDescriptor->setType(AssemblerAbstract::deduplicateTypes($type));
67 5
        $argumentDescriptor->setName($name);
68
69 5
        return $argumentDescriptor;
70
    }
71
}
72