Completed
Push — develop ( baf107...5b6026 )
by Jaap
06:21
created

UsesAssembler::setFirstReferencePartAsType()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 10
Code Lines 7

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 7
nc 1
nop 2
dl 0
loc 10
rs 9.4285
c 0
b 0
f 0
1
<?php
2
/**
3
 * phpDocumentor
4
 *
5
 * PHP Version 5.3
6
 *
7
 * @copyright 2010-2014 Mike van Riel / Naenius (http://www.naenius.com)
8
 * @license   http://www.opensource.org/licenses/mit-license.php MIT
9
 * @link      http://phpdoc.org
10
 */
11
12
namespace phpDocumentor\Descriptor\Builder\Reflector\Tags;
13
14
use phpDocumentor\Compiler\Linker\Linker;
15
use phpDocumentor\Descriptor\Builder\Reflector\AssemblerAbstract;
16
use phpDocumentor\Descriptor\Tag\UsesDescriptor;
17
use phpDocumentor\Reflection\DocBlock\Context;
18
use phpDocumentor\Reflection\DocBlock\Tag\UsesTag;
19
use phpDocumentor\Reflection\DocBlock\Type\Collection;
20
21
class UsesAssembler extends AssemblerAbstract
22
{
23
    /**
24
     * Creates a new Descriptor from the given Reflector.
25
     *
26
     * @param UsesTag $data
27
     *
28
     * @return UsesDescriptor
29
     */
30
    public function create($data)
31
    {
32
        $descriptor = new UsesDescriptor($data->getName());
33
        $descriptor->setDescription($data->getDescription());
34
        $reference = $data->getReference();
35
        $context = $data->getDocBlock() ? $data->getDocBlock()->getContext() : null;
36
37
        if ($reference !== 'self'
38
            && $reference !== '$this'
39
            && $reference[0] !== '\\'
40
        ) {
41
            // Expand FQCN part of the FQSEN
42
            $referenceParts = explode('::', $reference);
43
44
            if (count($referenceParts) > 1 || $this->referenceIsNamespaceAlias($reference, $context)) {
0 ignored issues
show
Bug introduced by
It seems like $context defined by $data->getDocBlock() ? $...()->getContext() : null on line 35 can be null; however, phpDocumentor\Descriptor...renceIsNamespaceAlias() does not accept null, maybe add an additional type check?

Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code:

/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
Loading history...
45
                $referenceParts = $this->setFirstReferencePartAsType($context, $referenceParts);
0 ignored issues
show
Bug introduced by
It seems like $context defined by $data->getDocBlock() ? $...()->getContext() : null on line 35 can be null; however, phpDocumentor\Descriptor...stReferencePartAsType() does not accept null, maybe add an additional type check?

Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code:

/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
Loading history...
46
            } elseif (isset($reference[0])) {
47
                array_unshift($referenceParts, Linker::CONTEXT_MARKER);
48
            }
49
50
            $reference = implode('::', $referenceParts);
51
        }
52
53
        $descriptor->setReference($reference);
54
55
        return $descriptor;
0 ignored issues
show
Bug Best Practice introduced by
The return type of return $descriptor; (phpDocumentor\Descriptor\Tag\UsesDescriptor) 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...
56
    }
57
58
    /**
59
     * @param Context $context
60
     * @param string[] $referenceParts
61
     * @return array The returned array will consist of a Collection object with the type, and strings for methods, etc.
62
     */
63
    private function setFirstReferencePartAsType($context, $referenceParts)
64
    {
65
        $type = current($referenceParts);
66
        $type = new Collection(
67
            array($type),
0 ignored issues
show
Documentation introduced by
array($type) is of type array<integer,string|false,{"0":"string|false"}>, but the function expects a array<integer,string>.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
68
            $context
69
        );
70
        $referenceParts[0] = $type;
71
        return $referenceParts;
72
    }
73
74
    /**
75
     * When you have a relative reference to a class, we need to check if this class exists in the namespace aliases
76
     *
77
     * @param string $reference
78
     * @param Context $context
79
     * @return bool
80
     */
81
    private function referenceIsNamespaceAlias($reference, $context)
82
    {
83
        /** @var \phpDocumentor\Reflection\DocBlock\Context $context*/
84
        foreach ($context->getNamespaceAliases() as $alias) {
85
            if (substr($alias, -strlen($reference)) === $reference) {
86
                return true;
87
            }
88
        }
89
    }
90
}
91