1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
<?php
namespace ipl\Stdlib;
use OutOfBoundsException;
use Traversable;
/**
* Trait for property access, mutation and array access.
*/
trait Properties
{
/** @var array */
private $properties = [];
/**
* Get whether this class has any properties
*
* @return bool
*/
public function hasProperties()
{
return ! empty($this->properties);
}
/**
* Get whether a property with the given key exists
*
* @param string $key
*
* @return bool
*/
public function hasProperty($key)
{
return array_key_exists($key, $this->properties);
}
/**
* Set the given properties
*
* @param array $properties
*
* @return $this
*/
public function setProperties(array $properties)
{
foreach ($properties as $key => $value) {
$this->setProperty($key, $value);
}
return $this;
}
/**
* Get the property by the given key
*
* @param string $key
*
* @return mixed
*
* @throws OutOfBoundsException If the property by the given key does not exist
*/
protected function getProperty($key)
{
if (array_key_exists($key, $this->properties)) {
return $this->properties[$key];
}
throw new OutOfBoundsException("Can't access property '$key'. Property does not exist");
}
/**
* Set a property with the given key and value
*
* @param string $key
* @param mixed $value
*
* @return $this
*/
protected function setProperty($key, $value)
{
$this->properties[$key] = $value;
return $this;
}
/**
* Iterate over all existing properties
*
* @return Traversable
*/
public function getIterator(): Traversable
{
foreach ($this->properties as $key => $value) {
yield $key => $value;
}
}
/**
* Check whether an offset exists
*
* @param mixed $offset
*
* @return bool
*/
public function offsetExists($offset): bool
{
return isset($this->properties[$offset]);
}
/**
* Get the value for an offset
*
* @param mixed $offset
*
* @return mixed
*/
#[\ReturnTypeWillChange]
public function offsetGet($offset)
{
return $this->getProperty($offset);
}
/**
* Set the value for an offset
*
* @param mixed $offset
* @param mixed $value
*/
public function offsetSet($offset, $value): void
{
$this->setProperty($offset, $value);
}
/**
* Unset the value for an offset
*
* @param mixed $offset
*/
public function offsetUnset($offset): void
{
unset($this->properties[$offset]);
}
/**
* Get the value of a non-public property
*
* This is a PHP magic method which is implicitly called upon access to non-public properties,
* e.g. `$value = $object->property;`.
* Do not call this method directly.
*
* @param mixed $key
*
* @return mixed
*/
public function __get($key)
{
return $this->getProperty($key);
}
/**
* Set the value of a non-public property
*
* This is a PHP magic method which is implicitly called upon access to non-public properties,
* e.g. `$object->property = $value;`.
* Do not call this method directly.
*
* @param string $key
* @param mixed $value
*/
public function __set($key, $value)
{
$this->setProperty($key, $value);
}
/**
* Check whether a non-public property is defined and not null
*
* This is a PHP magic method which is implicitly called upon access to non-public properties,
* e.g. `isset($object->property);`.
* Do not call this method directly.
*
* @param string $key
*
* @return bool
*/
public function __isset($key)
{
return $this->offsetExists($key);
}
/**
* Unset the value of a non-public property
*
* This is a PHP magic method which is implicitly called upon access to non-public properties,
* e.g. `unset($object->property);`. This method does nothing if the property does not exist.
* Do not call this method directly.
*
* @param string $key
*/
public function __unset($key)
{
$this->offsetUnset($key);
}
}
|
