forked from yii2tech/embedded
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ContainerTrait.php
260 lines (244 loc) · 7.85 KB
/
ContainerTrait.php
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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
<?php
/**
* @link https://github.com/yii2tech
* @copyright Copyright (c) 2015 Yii2tech
* @license [New BSD License](http://www.opensource.org/licenses/bsd-license.php)
*/
namespace yii2tech\embedded;
use yii\base\InvalidConfigException;
use yii\base\InvalidParamException;
use Yii;
/**
* ContainerTrait can be used to satisfy [[ContainerInterface]].
*
* For each embedded entity a mapping declaration should be provided.
* In order to do so you need to declare method, which name is prefixed with 'embedded', which
* should return the [[Mapping]] instance. You may use [[hasEmbedded()]] and [[hasEmbeddedList()]] for this.
*
* Per each of source field or property a new virtual property will declared, which name will be composed
* by removing 'embedded' prefix from the declaration method name.
*
* Note: watch for the naming collisions: if you have a source property named 'profile' the mapping declaration
* for it should have different name, like 'profileModel'.
*
* Example:
*
* ```php
* use yii\base\Model;
* use yii2tech\embedded\ContainerInterface;
* use yii2tech\embedded\ContainerTrait;
*
* class User extends Model implements ContainerInterface
* {
* use ContainerTrait;
*
* public $profileData = [];
* public $commentsData = [];
*
* public function embedProfile()
* {
* return $this->mapEmbedded('profileData', Profile::className());
* }
*
* public function embedComments()
* {
* return $this->mapEmbeddedList('commentsData', Comment::className());
* }
* }
*
* $user = new User();
* $user->profile->firstName = 'John';
* $user->profile->lastName = 'Doe';
*
* $comment = new Comment();
* $user->comments[] = $comment;
* ```
*
* In order to synchronize values between embedded entities and container use [[refreshFromEmbedded()]] method.
*
* @see ContainerInterface
* @see Mapping
*
* @author Paul Klimov <[email protected]>
* @since 1.0
*/
trait ContainerTrait
{
/**
* @var Mapping[]
*/
private $_embedded = [];
/**
* PHP getter magic method.
* This method is overridden so that embedded objects can be accessed like properties.
*
* @param string $name property name
* @throws \yii\base\InvalidParamException if relation name is wrong
* @return mixed property value
* @see getAttribute()
*/
public function __get($name)
{
if ($this->hasEmbedded($name)) {
return $this->getEmbedded($name);
}
return parent::__get($name);
}
/**
* PHP setter magic method.
* This method is overridden so that embedded objects can be accessed like properties.
* @param string $name property name
* @param mixed $value property value
*/
public function __set($name, $value)
{
if ($this->hasEmbedded($name)) {
$this->setEmbedded($name, $value);
} else {
parent::__set($name, $value);
}
}
/**
* Checks if a property value is null.
* This method overrides the parent implementation by checking if the embedded object is null or not.
* @param string $name the property name or the event name
* @return boolean whether the property value is null
*/
public function __isset($name)
{
if (isset($this->_embedded[$name])) {
return ($this->_embedded[$name]->getValue($this) === null);
}
return parent::__isset($name);
}
/**
* Sets a component property to be null.
* This method overrides the parent implementation by clearing
* the specified embedded object.
* @param string $name the property name or the event name
*/
public function __unset($name)
{
if (isset($this->_embedded[$name])) {
($this->_embedded[$name]->setValue(null));
} else {
parent::__unset($name);
}
}
/**
* Sets embedded object or list of objects.
* @param string $name embedded name
* @param object|object[]|null $value embedded value.
*/
public function setEmbedded($name, $value)
{
$this->getEmbeddedMapping($name)->setValue($value);
}
/**
* Returns embedded object or list of objects.
* @param string $name embedded name.
* @return object|object[]|null embedded value.
*/
public function getEmbedded($name)
{
return $this->getEmbeddedMapping($name)->getValue($this);
}
/**
* Returns mapping information about specified embedded entity.
* @param string $name embedded name.
* @throws \yii\base\InvalidParamException if specified embedded does not exists.
* @throws \yii\base\InvalidConfigException on invalid mapping declaration.
* @return Mapping embedded mapping.
*/
public function getEmbeddedMapping($name)
{
if (!isset($this->_embedded[$name])) {
$method = $this->composeEmbeddedDeclarationMethodName($name);
if (!method_exists($this, $method)) {
throw new InvalidParamException("'" . get_class($this) . "' has no declaration ('{$method}()') for the embedded '{$name}'");
}
$mapping = call_user_func([$this, $method]);
if (!$mapping instanceof Mapping) {
throw new InvalidConfigException("Mapping declaration '" . get_class($this) . "::{$method}()' should return instance of '" . Mapping::className() . "'");
}
$this->_embedded[$name] = $mapping;
}
return $this->_embedded[$name];
}
/**
* Checks if asked embedded declaration exists.
* @param string $name embedded name
* @return boolean whether embedded declaration exists.
*/
public function hasEmbedded($name)
{
return (isset($this->_embedded[$name])) || method_exists($this, $this->composeEmbeddedDeclarationMethodName($name));
}
/**
* Declares embedded object.
* @param string $source source field name
* @param string|array $target target class or array configuration.
* @param array $config mapping extra configuration.
* @return Mapping embedding mapping instance.
*/
public function mapEmbedded($source, $target, array $config = [])
{
return Yii::createObject(array_merge(
[
'class' => Mapping::className(),
'source' => $source,
'target' => $target,
'multiple' => false,
],
$config
));
}
/**
* Declares embedded list of objects.
* @param string $source source field name
* @param string|array $target target class or array configuration.
* @param array $config mapping extra configuration.
* @return Mapping embedding mapping instance.
*/
public function mapEmbeddedList($source, $target, array $config = [])
{
return Yii::createObject(array_merge(
[
'class' => Mapping::className(),
'source' => $source,
'target' => $target,
'multiple' => true,
],
$config
));
}
/**
* @param string $name embedded name.
* @return string declaration method name.
*/
private function composeEmbeddedDeclarationMethodName($name)
{
return 'embed' . $name;
}
/**
* Returns list of values from embedded objects named by source fields.
* @return array embedded values.
*/
public function getEmbeddedValues()
{
$values = [];
foreach ($this->_embedded as $embedded) {
$values[$embedded->source] = $embedded->extractValues($this);
}
return $values;
}
/**
* Fills up own fields by values fetched from embedded objects.
*/
public function refreshFromEmbedded()
{
foreach ($this->getEmbeddedValues() as $name => $value) {
$this->$name = $value;
}
}
}