1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
namespace Nayjest\Tree; |
4
|
|
|
|
5
|
|
|
use Evenement\EventEmitterTrait; |
6
|
|
|
use Nayjest\Collection\Extended\ObjectCollection; |
7
|
|
|
use Nayjest\Tree\Exception\LockedNodeException; |
8
|
|
|
use Nayjest\Tree\Exception\NoParentException; |
9
|
|
|
use Nayjest\Tree\Exception\ReadonlyNodeModifyException; |
10
|
|
|
|
11
|
|
|
/** |
12
|
|
|
* Trait ChildNodeTrait. |
13
|
|
|
* |
14
|
|
|
* @implements ChildNodeInterface |
15
|
|
|
* @see ChildNodeInterface |
16
|
|
|
*/ |
17
|
|
|
trait ChildNodeTrait |
18
|
|
|
{ |
19
|
|
|
use EventEmitterTrait; |
20
|
|
|
|
21
|
|
|
/** |
22
|
|
|
* @internal |
23
|
|
|
* |
24
|
|
|
* @var ParentNodeInterface|ChildNodeInterface |
25
|
|
|
* */ |
26
|
|
|
private $parentNode; |
27
|
|
|
|
28
|
|
|
private $locked = false; |
29
|
|
|
|
30
|
|
|
/** |
31
|
|
|
* Attaches component to registry. |
32
|
|
|
* |
33
|
|
|
* @param ParentNodeInterface $parent |
34
|
|
|
* |
35
|
|
|
* @return null |
36
|
|
|
*/ |
37
|
|
|
final public function internalSetParent(ParentNodeInterface $parent) |
38
|
|
|
{ |
39
|
|
|
$this->emit('parent.change', [$parent, $this]); |
40
|
|
|
$this->parentNode = $parent; |
41
|
|
|
} |
42
|
|
|
|
43
|
|
|
final public function internalUnsetParent() |
44
|
|
|
{ |
45
|
|
|
$this->emit('parent.change', [null, $this]); |
46
|
|
|
$this->parentNode = null; |
47
|
|
|
} |
48
|
|
|
|
49
|
|
|
/** |
50
|
|
|
* Returns parent node. |
51
|
|
|
* |
52
|
|
|
* @return ParentNodeInterface|null |
53
|
|
|
*/ |
54
|
|
|
final public function parent() |
55
|
|
|
{ |
56
|
|
|
return $this->parentNode; |
57
|
|
|
} |
58
|
|
|
|
59
|
|
|
/** |
60
|
|
|
* @return ObjectCollection |
61
|
|
|
*/ |
62
|
|
|
public function parents() |
63
|
|
|
{ |
64
|
|
|
$parents = new ObjectCollection(); |
65
|
|
|
$current = $this->parent(); |
66
|
|
|
while ($current instanceof ParentNodeInterface) { |
67
|
|
|
$parents->add($current); |
68
|
|
|
if (!$current instanceof ChildNodeInterface) { |
69
|
|
|
break; |
70
|
|
|
} |
71
|
|
|
$current = $current->parent(); |
72
|
|
|
} |
73
|
|
|
|
74
|
|
|
return $parents; |
75
|
|
|
} |
76
|
|
|
|
77
|
|
|
final public function detach() |
78
|
|
|
{ |
79
|
|
|
$this->checkParentRelation($this->parentNode); |
80
|
|
|
$this->parentNode->children()->remove($this); |
81
|
|
|
|
82
|
|
|
return $this; |
83
|
|
|
} |
84
|
|
|
|
85
|
|
|
final public function attachTo(ParentNodeInterface $parent) |
86
|
|
|
{ |
87
|
|
|
$this->checkParentRelation($parent); |
88
|
|
|
$parent->children()->add($this); |
|
|
|
|
89
|
|
|
|
90
|
|
|
return $this; |
91
|
|
|
} |
92
|
|
|
|
93
|
|
|
public function onParentChange(callable $callback, $once = false) |
94
|
|
|
{ |
95
|
|
|
if ($once) { |
96
|
|
|
$this->once('parent.change', $callback); |
97
|
|
|
} else { |
98
|
|
|
$this->on('parent.change', $callback); |
99
|
|
|
} |
100
|
|
|
|
101
|
|
|
return $this; |
102
|
|
|
} |
103
|
|
|
|
104
|
|
|
private function checkParentRelation(ParentNodeInterface $parent = null) |
105
|
|
|
{ |
106
|
|
|
if ($parent === null) { |
107
|
|
|
throw new NoParentException(); |
108
|
|
|
} |
109
|
|
|
if (!$parent->isWritable()) { |
110
|
|
|
throw new ReadonlyNodeModifyException(); |
111
|
|
|
} |
112
|
|
|
if ($this->isLocked()) { |
113
|
|
|
throw new LockedNodeException(); |
114
|
|
|
} |
115
|
|
|
} |
116
|
|
|
|
117
|
|
|
public function lock() |
118
|
|
|
{ |
119
|
|
|
$this->locked = true; |
120
|
|
|
|
121
|
|
|
return $this; |
122
|
|
|
} |
123
|
|
|
|
124
|
|
|
public function unlock() |
125
|
|
|
{ |
126
|
|
|
$this->locked = false; |
127
|
|
|
|
128
|
|
|
return $this; |
129
|
|
|
} |
130
|
|
|
|
131
|
|
|
public function isLocked() |
132
|
|
|
{ |
133
|
|
|
return $this->locked; |
134
|
|
|
} |
135
|
|
|
} |
136
|
|
|
|
Let’s take a look at an example:
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
Change the type-hint for the parameter:
Add an additional type-check:
Add the method to the interface: