These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more
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\Descriptor\Builder\Reflector\AssemblerAbstract; |
||
15 | use phpDocumentor\Descriptor\Tag\AuthorDescriptor; |
||
16 | use phpDocumentor\Reflection\DocBlock\Tag\AuthorTag; |
||
17 | use phpDocumentor\Reflection\DocBlock\Tags\Author; |
||
18 | |||
19 | /** |
||
20 | * Constructs a new descriptor from the Reflector for an `@author` tag. |
||
21 | * |
||
22 | * This object will read the reflected information for the `@author` tag and create a {@see AuthorDescriptor} object |
||
23 | * that can be used in the rest of the application and templates. |
||
24 | */ |
||
25 | class AuthorAssembler extends AssemblerAbstract |
||
26 | { |
||
27 | /** |
||
28 | * Creates a new Descriptor from the given Reflector. |
||
29 | * |
||
30 | * @param Author $data |
||
31 | * |
||
32 | * @return AuthorDescriptor |
||
33 | */ |
||
34 | public function create($data) |
||
35 | { |
||
36 | $descriptor = new AuthorDescriptor($data->getName()); |
||
37 | $descriptor->setDescription($data->getDescription()); |
||
0 ignored issues
–
show
|
|||
38 | |||
39 | return $descriptor; |
||
0 ignored issues
–
show
The return type of
return $descriptor; (phpDocumentor\Descriptor\Tag\AuthorDescriptor ) 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
Loading history...
|
|||
40 | } |
||
41 | } |
||
42 |
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: