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 InvalidArgumentException; |
||
19 | use phpDocumentor\Descriptor\Builder\Reflector\AssemblerAbstract; |
||
20 | use phpDocumentor\Descriptor\Example\Finder; |
||
21 | use phpDocumentor\Descriptor\Tag\ExampleDescriptor; |
||
22 | use phpDocumentor\Reflection\DocBlock\ExampleFinder; |
||
23 | use phpDocumentor\Reflection\DocBlock\Tags\Example; |
||
24 | use Webmozart\Assert\Assert; |
||
25 | |||
26 | /** |
||
27 | * This class collects data from the example tag definition of the Reflection library, tries to find the correlating |
||
28 | * example file on disk and creates a complete Descriptor from that. |
||
29 | */ |
||
30 | class ExampleAssembler extends AssemblerAbstract |
||
31 | { |
||
32 | /** @var Finder */ |
||
33 | private $finder; |
||
34 | |||
35 | /** |
||
36 | * Initializes this assembler with the means to find the example file on disk. |
||
37 | */ |
||
38 | 1 | public function __construct(ExampleFinder $finder) |
|
39 | { |
||
40 | 1 | $this->finder = $finder; |
|
41 | 1 | } |
|
42 | |||
43 | /** |
||
44 | * Creates a new Descriptor from the given Reflector. |
||
45 | * |
||
46 | * @param Example $data |
||
47 | * |
||
48 | * @throws InvalidArgumentException if the provided parameter is not of type ExampleTag; the interface won't let |
||
49 | * up typehint the signature. |
||
50 | * |
||
51 | * @return ExampleDescriptor |
||
52 | */ |
||
53 | 2 | public function create($data) |
|
54 | { |
||
55 | 2 | Assert::isInstanceOf($data, Example::class); |
|
56 | 1 | $descriptor = new ExampleDescriptor($data->getName()); |
|
57 | 1 | $descriptor->setFilePath((string) $data->getFilePath()); |
|
58 | 1 | $descriptor->setStartingLine($data->getStartingLine()); |
|
59 | 1 | $descriptor->setLineCount($data->getLineCount()); |
|
60 | 1 | $descriptor->setDescription($data->getDescription()); |
|
61 | 1 | $descriptor->setExample($this->finder->find($data)); |
|
62 | |||
63 | 1 | return $descriptor; |
|
0 ignored issues
–
show
|
|||
64 | } |
||
65 | } |
||
66 |
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.