-
Notifications
You must be signed in to change notification settings - Fork 238
/
Entity.php
392 lines (352 loc) · 10.1 KB
/
Entity.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
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
<?php
/**
* Lithium: the most rad php framework
*
* @copyright Copyright 2010, Union of RAD (http://union-of-rad.org)
* @license http://opensource.org/licenses/bsd-license.php The BSD License
*/
namespace lithium\data;
use \RuntimeException;
use \lithium\data\Source;
use \lithium\util\Collection as Col;
/**
* `Entity` class. Represents data such as a row or document in a database. Entities have fields
* (often known as columns in databases).
*/
class Entity extends \lithium\core\Object {
/**
* Namespaced name of model that this record is linked to.
*/
protected $_model = null;
/**
* Associative array of the entity's fields and values.
*/
protected $_data = array();
/**
* An array containing all related records and recordsets, keyed by relationship name, as
* defined in the bound model class.
*
* @var array
*/
protected $_relationships = array();
/**
* If this record is chained off of another, contains the origin object.
*
* @var object
*/
protected $_parent = null;
/**
* A reference to the object that originated this record set; usually an instance of
* `lithium\data\Source` or `lithium\data\source\Database`. Used to load column definitions and
* lazy-load records.
*
* @var object
*/
protected $_handle = null;
/**
* Validation errors
*/
protected $_errors = array();
/**
* An array of flags to track which fields in this record have been modified, where the keys
* are field names, and the values are always `true`. If, for example, a change to a field is
* reverted, that field's flag should be unset from the list.
*
* @var array
*/
protected $_modified = array();
/**
* A flag indicating whether or not this record exists. Set to false if this is a newly-created
* record, or if this record has been loaded and subsequently deleted. True if the record has
* been loaded from the database, or has been created and subsequently saved.
*
* @var boolean
*/
protected $_exists = false;
/**
* A local copy of the schema definition. This is the same as `lithium\data\Model::$_schema`,
* but can be defined here if this is a one-off object or class used for a single purpose, i.e.
* to create a form.
*
* @var array
*/
protected $_schema = array();
/**
* Auto configuration.
*
* @var array
*/
protected $_autoConfig = array(
'classes' => 'merge', 'parent', 'relationship',
'handle', 'schema', 'data', 'model', 'exists'
);
/**
* Creates a new record object with default values.
*
* Options defined:
* - 'data' _array_: Data to enter into the record. Defaults to an empty array.
* - 'model' _string_: Class name that provides the data-source for this record.
* Defaults to `null`.
*
* @param array $config
* @return object Record object.
*/
public function __construct(array $config = array()) {
$defaults = array('model' => null, 'data' => array());
parent::__construct($config + $defaults);
}
/**
* Overloading for reading inaccessible properties.
*
* @param string $name Property name.
* @return mixed Result.
*/
public function &__get($name) {
$data = null;
$null = null;
if (isset($this->_relationships[$name])) {
return $this->_relationships[$name];
}
if (($model = $this->_model) && $this->_handle) {
foreach ($model::relations() as $relation => $config) {
$linkKey = $config->data('fieldName');
$type = $config->data('type') == 'hasMany' ? 'set' : 'entity';
$class = $this->_classes[$type];
if ($linkKey === $name) {
$data = isset($this->_data[$name]) ? $this->_data[$name] : array();
$this->_relationships[$name] = new $class();
return $this->_relationships[$name];
}
}
}
if (isset($this->_data[$name])) {
return $this->_data[$name];
}
return $null;
}
/**
* Overloading for writing to inaccessible properties.
*
* @param string $name Property name.
* @param string $value Property value.
* @return mixed Result.
*/
public function __set($name, $value) {
$this->_modified[$name] = true;
$this->_data[$name] = $value;
}
/**
* Overloading for calling `isset()` or `empty()` on inaccessible properties.
*
* @param string $name Property name.
* @return mixed Result.
*/
public function __isset($name) {
return array_key_exists($name, $this->_data);
}
/**
* Magic method that allows calling of model methods on this record instance, i.e.:
* {{{
* $record->validates();
* }}}
*
* @param string $method
* @param array $params
* @return mixed
*/
public function __call($method, $params) {
if (!($model = $this->_model) || !method_exists($model, $method)) {
throw new RuntimeException("No model bound or unhandled method call '{$method}'.");
}
array_unshift($params, $this);
$class = $model::invokeMethod('_instance');
return call_user_func_array(array(&$class, $method), $params);
}
/**
* Allows several properties to be assigned at once, i.e.:
* {{{
* $record->set(array('title' => 'Lorem Ipsum', 'value' => 42));
* }}}
*
* @param $values An associative array of fields and values to assign to the `Record`.
* @return void
*/
public function set($values) {
foreach ($values as $name => $value) {
$this->__set($name, $value);
}
}
/**
* Access the data fields of the record. Can also access a $named field.
*
* @param string $name Optionally included field name.
* @return array|string Entire data array if $name is empty, otherwise the value from the named
* field.
*/
public function data($name = null) {
return empty($name) ? $this->_data : $this->__get($name);
}
/**
* Returns the model which this entity is bound to.
*
* @return string The fully qualified model class name.
*/
public function model() {
return $this->_model;
}
public function schema($field = null) {
switch (true) {
case ($this->_schema):
$schema = $this->_schema;
break;
case ($model = $this->_model):
$schema = $model::schema();
break;
default:
$schema = array();
break;
}
if ($field) {
return isset($self->_schema[$field]) ? $self->_schema[$field] : null;
}
return $schema;
}
/**
* Access the errors of the record.
*
* @param array|string $field If an array, overwrites `$this->_errors`. If a string, and $value
* is not null, sets the corresponding key in $this->_errors to $value
* @param string $value Value to set.
* @return array|string Either the $this->_errors array, or single value from it.
*/
public function errors($field = null, $value = null) {
if ($field === null) {
return $this->_errors;
}
if (is_array($field)) {
$this->_errors = $field;
return $this->_errors;
}
if ($value === null && isset($this->_errors[$field])) {
return $this->_errors[$field];
}
if ($value !== null) {
return $this->_errors[$field] = $value;
}
return $value;
}
/**
* A flag indicating whether or not this record exists.
*
* @return boolean `True` if the record was `read` from the data-source, or has been `create`d
* and `save`d. Otherwise `false`.
*/
public function exists() {
return $this->_exists;
}
/**
* Called after an `Entity` is saved. Updates the object's internal state to reflect the
* corresponding database record, and sets the `Record`'s primary key, if this is a
* newly-created object.
*
* @param mixed $id The ID to assign, where applicable.
* @param array $data Any additional generated data assigned to the object by the database.
* @return void
*/
public function update($id = null, array $data = array()) {
$this->_modified = array();
$this->_exists = true;
if (!$id) {
return;
}
$model = $this->_model;
$key = $model::meta('key');
if (is_array($key)) {
foreach ($key as $i => $k) {
$this->_data[$k] = $id[$i];
}
} else {
$this->_data[$key] = $id;
}
foreach ($data as $key => $value) {
$this->_data[$key] = $value;
}
}
/**
* Gets the array of fields modified on this entity.
*
* @return array Returns an array where the keys are entity field names, and the values are
* always `true`.
*/
public function modified() {
if (!$this->_exists) {
$keys = array_keys($this->_data);
return array_combine($keys, array_fill(0, count($keys), true));
}
return $this->_modified;
}
public function export(Source $dataSource, array $options = array()) {
return array_intersect_key($this->_data, $this->_modified);
}
/**
* Configures protected properties of a `Record` so that it is parented to `$parent`.
*
* @param object $parent
* @param array $config
* @return void
*/
public function assignTo($parent, array $config = array()) {
foreach ($config as $key => $val) {
$this->{'_' . $key} = $val;
}
$this->_parent =& $parent;
}
/**
* Converts the data in the record set to a different format, i.e. an array.
*
* @param string $format currently only `array`
* @param array $options
* @return mixed
*/
public function to($format, array $options = array()) {
switch ($format) {
case 'array':
$result = Col::toArray($this->_data);
break;
default:
$result = $this;
break;
}
return $result;
}
/**
* Instantiates a new `Document` object as a descendant of the current object, and sets all
* default values and internal state.
*
* @param string $classType The type of class to create, either `'entity'` or `'set'`.
* @param array $data
* @param array $options
* @return object Returns a new `Document` object instance.
*/
protected function _relation($classType, $key, $data, $options = array()) {
$parent = $this;
$key = ($key === null) ? count($this->_data) : $key;
$pathKey = trim("{$this->_pathKey}.{$key}", '.');
if (($key || $key === 0) && $model = $this->_model) {
foreach ($model::relations() as $name => $relation) {
if ($key === $relation->data('fieldName')) {
$model = $relation->data('to');
break;
}
}
}
if (is_object($data) && $data instanceof Entity) {
$data->assignTo($this, compact('model', 'pathKey'));
return $data;
}
$exists = $this->_exists;
$options += compact('model', 'data', 'parent', 'exists', 'pathKey');
return new $this->_classes[$classType]($options);
}
}
?>