These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more
1 | <?php |
||
2 | |||
3 | namespace SRF\Formats\Tree; |
||
4 | |||
5 | use Cdb\Exception; |
||
6 | use Tree\Node\Node; |
||
7 | use Tree\Node\NodeInterface; |
||
8 | use Tree\Node\NodeTrait; |
||
9 | |||
10 | class TreeNode extends Node { |
||
11 | |||
12 | /** |
||
13 | * SRFTreeElement constructor. |
||
14 | * |
||
15 | * @param \SMWResultArray[] | null $row |
||
16 | */ |
||
17 | 5 | public function __construct( $row = null ) { |
|
18 | 5 | parent::__construct( $row ); |
|
19 | 5 | } |
|
20 | |||
21 | /** |
||
22 | * @return string |
||
23 | */ |
||
24 | 5 | public function getHash() { |
|
25 | |||
26 | 5 | $resultSubject = $this->getResultSubject(); |
|
27 | |||
28 | 5 | if ( $resultSubject !== null ) { |
|
29 | 5 | return $resultSubject->getSerialization(); |
|
30 | } |
||
31 | |||
32 | 5 | return ''; |
|
33 | } |
||
34 | |||
35 | /** |
||
36 | * @return null|\SMWDIWikiPage |
||
37 | */ |
||
38 | 5 | public function getResultSubject() { |
|
39 | /** @var \SMWResultArray[] | null $row */ |
||
40 | 5 | $row = $this->getValue(); |
|
41 | |||
42 | 5 | if ( $row !== null ) { |
|
43 | 5 | return $row[0]->getResultSubject(); |
|
44 | } |
||
45 | |||
46 | 5 | return null; |
|
47 | } |
||
48 | |||
49 | /** |
||
50 | * @param NodeInterface $child |
||
51 | * |
||
52 | * @return NodeTrait |
||
0 ignored issues
–
show
|
|||
53 | * @throws Exception |
||
54 | */ |
||
55 | 5 | public function addChild( NodeInterface $child ) { |
|
56 | |||
57 | 5 | foreach ( $this->getAncestorsAndSelf() as $ancestor ) { |
|
58 | 5 | if ( $ancestor->getHash() === $child->getHash() ) { |
|
0 ignored issues
–
show
It seems like you code against a concrete implementation and not the interface
Tree\Node\NodeInterface as the method getHash() does only exist in the following implementations of said interface: SRF\Formats\Tree\TreeNode .
Let’s take a look at an example: interface User
{
/** @return string */
public function getPassword();
}
class MyUser implements User
{
public function getPassword()
{
// return something
}
public function getDisplayName()
{
// return some name.
}
}
class AuthSystem
{
public function authenticate(User $user)
{
$this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
// do something.
}
}
In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types
inside the if block in such a case.
Loading history...
|
|||
59 | 5 | throw new Exception( 'srf-tree-circledetected' ); |
|
60 | } |
||
61 | } |
||
62 | |||
63 | 5 | return parent::addChild( $child ); |
|
0 ignored issues
–
show
The return type of
return parent::addChild($child); (SRF\Formats\Tree\TreeNode ) is incompatible with the return type of the parent method Tree\Node\Node::addChild of type Tree\Node\NodeTrait .
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...
|
|||
64 | } |
||
65 | |||
66 | } |
||
67 | |||
68 |
In PHP traits cannot be used for type-hinting as they do not define a well-defined structure. This is because any class that uses a trait can rename that trait’s methods.
If you would like to return an object that has a guaranteed set of methods, you could create a companion interface that lists these methods explicitly.