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\SeeDescriptor; |
17
|
|
|
use phpDocumentor\Reflection\DocBlock\Tag\SeeTag; |
18
|
|
|
use phpDocumentor\Reflection\DocBlock\Type\Collection; |
19
|
|
|
|
20
|
|
|
/** |
21
|
|
|
* Constructs a new Descriptor from a Reflector object for the `@see` tag. |
22
|
|
|
* |
23
|
|
|
* This class will gather the properties that were parsed by the Reflection mechanism for, specifically, an `@see` tag |
24
|
|
|
* and use that to create a SeeDescriptor that describes all properties that an `@see` tag may have. |
25
|
|
|
*/ |
26
|
|
|
class SeeAssembler extends AssemblerAbstract |
27
|
|
|
{ |
28
|
|
|
/** |
29
|
|
|
* Creates a new Descriptor from the given Reflector. |
30
|
|
|
* |
31
|
|
|
* @param SeeTag $data |
32
|
|
|
* |
33
|
|
|
* @return SeeDescriptor |
34
|
|
|
*/ |
35
|
|
|
public function create($data) |
36
|
|
|
{ |
37
|
|
|
$descriptor = new SeeDescriptor($data->getName()); |
38
|
|
|
$descriptor->setDescription($data->getDescription()); |
39
|
|
|
|
40
|
|
|
$reference = $data->getReference(); |
41
|
|
|
|
42
|
|
|
if (substr($reference, 0, 7) !== 'http://' |
43
|
|
|
&& substr($reference, 0, 8) !== 'https://' |
44
|
|
|
&& $reference !== 'self' |
45
|
|
|
&& $reference !== '$this' |
46
|
|
|
) { |
47
|
|
|
// TODO: move this to the ReflectionDocBlock component |
48
|
|
|
// Expand FQCN part of the FQSEN |
49
|
|
|
$referenceParts = explode('::', $reference); |
50
|
|
|
if (count($referenceParts) > 1 && $reference[0] != '\\') { |
51
|
|
|
$type = current($referenceParts); |
52
|
|
|
$type = new Collection( |
53
|
|
|
array($type), |
54
|
|
|
$data->getDocBlock() ? $data->getDocBlock()->getContext() : null |
55
|
|
|
); |
56
|
|
|
$referenceParts[0] = $type; |
57
|
|
|
} elseif (isset($reference[0]) && $reference[0] != '\\') { |
58
|
|
|
array_unshift($referenceParts, Linker::CONTEXT_MARKER); |
59
|
|
|
} |
60
|
|
|
|
61
|
|
|
$reference = implode('::', $referenceParts); |
62
|
|
|
} |
63
|
|
|
|
64
|
|
|
$descriptor->setReference($reference); |
65
|
|
|
|
66
|
|
|
return $descriptor; |
|
|
|
|
67
|
|
|
} |
68
|
|
|
} |
69
|
|
|
|
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:
Our function
my_function
expects aPost
object, and outputs the author of the post. The base classPost
returns a simple string and outputting a simple string will work just fine. However, the child classBlogPost
which is a sub-type ofPost
instead decided to return anobject
, and is therefore violating the SOLID principles. If aBlogPost
were passed tomy_function
, PHP would not complain, but ultimately fail when executing thestrtoupper
call in its body.