Completed
Push — develop ( 8eb671...133594 )
by Mike
19:30 queued 09:24
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());
0 ignored issues
show
It seems like $data->getDescription() targeting phpDocumentor\Reflection...seTag::getDescription() can also be of type null or object<phpDocumentor\Ref...n\DocBlock\Description>; however, phpDocumentor\Descriptor...iptor::setDescription() does only seem to accept string, maybe add an additional type check?

This check looks at variables that are passed out again to other methods.

If the outgoing method call has stricter type requirements than the method itself, an issue is raised.

An additional type check may prevent trouble.

Loading history...
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
            if (array_key_exists('name', $argument) && array_key_exists('type', $argument)) {
53 5
                $argumentDescriptor = $this->createArgumentDescriptorForMagicMethod(
54
                    $argument['name'],
55
                    $argument['type']
56 6
                );
57
                $descriptor->getArguments()->set($argumentDescriptor->getName(), $argumentDescriptor);
58
            }
59
        }
60
61
        return $descriptor;
62
    }
63 5
64
    /**
65 5
     * Construct an argument descriptor given the array representing an argument with a Method Tag in the Reflection
66 5
     * component.
67 5
     */
68
    private function createArgumentDescriptorForMagicMethod(string $name, Type $type): ArgumentDescriptor
69 5
    {
70
        $argumentDescriptor = new ArgumentDescriptor();
71
        $argumentDescriptor->setType(AssemblerAbstract::deduplicateTypes($type));
72
        $argumentDescriptor->setName($name);
73
74
        return $argumentDescriptor;
75
    }
76
}
77