1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
/* |
4
|
|
|
* The MIT License |
5
|
|
|
* |
6
|
|
|
* Copyright 2015 ekow. |
7
|
|
|
* |
8
|
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy |
9
|
|
|
* of this software and associated documentation files (the "Software"), to deal |
10
|
|
|
* in the Software without restriction, including without limitation the rights |
11
|
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
12
|
|
|
* copies of the Software, and to permit persons to whom the Software is |
13
|
|
|
* furnished to do so, subject to the following conditions: |
14
|
|
|
* |
15
|
|
|
* The above copyright notice and this permission notice shall be included in |
16
|
|
|
* all copies or substantial portions of the Software. |
17
|
|
|
* |
18
|
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
19
|
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
20
|
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
21
|
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
22
|
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
23
|
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN |
24
|
|
|
* THE SOFTWARE. |
25
|
|
|
*/ |
26
|
|
|
|
27
|
|
|
namespace ntentan\nibii; |
28
|
|
|
|
29
|
|
|
use ntentan\utils\Text; |
30
|
|
|
|
31
|
|
|
/** |
32
|
|
|
* Wraps a record from the database with data manipulation operations. |
33
|
|
|
* Wrapping a table with the record wrapper makes it possible to add, edit, |
34
|
|
|
* delete and query the underlying database. An MVC framework can use the |
35
|
|
|
* record wrapper as a base for its Model class. |
36
|
|
|
*/ |
37
|
|
|
class RecordWrapper implements \ArrayAccess, \Countable, \Iterator { |
38
|
|
|
|
39
|
|
|
protected $hasMany = []; |
40
|
|
|
protected $belongsTo = []; |
41
|
|
|
protected $manyHaveMany = []; |
42
|
|
|
protected $behaviours = []; |
43
|
|
|
protected $table; |
44
|
|
|
protected $schema; |
45
|
|
|
private $quotedTable; |
46
|
|
|
private $unquotedTable; |
47
|
|
|
private $modelData = []; |
48
|
|
|
private $invalidFields; |
49
|
|
|
private $dynamicOperations; |
50
|
|
|
private $index = 0; |
51
|
|
|
private $dataSet = false; |
52
|
|
|
|
53
|
|
|
/** |
54
|
|
|
* |
55
|
|
|
* @var DriverAdapter |
56
|
|
|
*/ |
57
|
|
|
private $adapter; |
58
|
|
|
private $container; |
59
|
|
|
private $context; |
60
|
|
|
private $keys = []; |
61
|
|
|
private $initialized = false; |
62
|
|
|
|
63
|
35 |
|
protected function initialize() { |
64
|
35 |
|
if($this->initialized) return; |
65
|
35 |
|
$this->context = ORMContext::getInstance($this->container); |
66
|
35 |
|
$this->container = $this->context->getContainer(); |
67
|
35 |
|
$this->adapter = $this->container->resolve(DriverAdapter::class); |
68
|
35 |
|
$table = $this->table ?? $this->context->getModelTable($this); |
69
|
1 |
|
$driver = $this->context->getDbContext()->getDriver(); |
70
|
1 |
|
$this->adapter->setContext($this->context); |
71
|
1 |
|
if (is_string($table)) { |
72
|
|
|
//$this->quotedTable = $driver->quoteIdentifier($table); |
|
|
|
|
73
|
|
|
$this->table = $this->unquotedTable = $table; |
74
|
|
|
} else { |
75
|
1 |
|
$this->table = $table['table']; |
76
|
1 |
|
$this->schema = $table['schema']; |
77
|
|
|
} |
78
|
1 |
|
$this->quotedTable = ($this->schema ? "{$driver->quoteIdentifier($this->schema)}." : "").$driver->quoteIdentifier($this->table); |
79
|
1 |
|
$this->unquotedTable = ($this->schema ? "{$this->schema}." : "").$this->table; |
80
|
1 |
|
$this->adapter->setModel($this, $this->quotedTable); |
81
|
1 |
|
foreach ($this->behaviours as $behaviour) { |
82
|
|
|
$behaviourInstance = $this->getComponentInstance($behaviour); |
|
|
|
|
83
|
|
|
$behaviourInstance->setModel($this); |
84
|
|
|
} |
85
|
1 |
|
$this->initialized = true; |
86
|
1 |
|
} |
87
|
|
|
|
88
|
|
|
public function __debugInfo() { |
|
|
|
|
89
|
|
|
$data = $this->getData(); |
90
|
|
|
return $this->hasMultipleItems() ? $data : isset($data[0]) ? $data[0] : []; |
91
|
|
|
} |
92
|
|
|
|
93
|
|
|
/** |
94
|
|
|
* |
95
|
|
|
* @return ModelDescription |
96
|
|
|
*/ |
97
|
|
|
public function getDescription() { |
98
|
|
|
$this->initialize(); |
99
|
|
|
return $this->context->getCache()->read( |
100
|
|
|
(new \ReflectionClass($this))->getName().'::desc', function() { |
101
|
|
|
return $this->container->resolve(ModelDescription::class, ['model' => $this]); |
102
|
|
|
} |
103
|
|
|
); |
104
|
|
|
} |
105
|
|
|
|
106
|
|
|
/** |
107
|
|
|
* Return the number of items stored in the model or the query. |
108
|
|
|
* @return integer |
|
|
|
|
109
|
|
|
*/ |
110
|
|
|
public function count() { |
111
|
|
|
if ($this->dataSet) { |
112
|
|
|
return count($this->getData()); |
113
|
|
|
} else { |
114
|
|
|
return $this->__call('count', []); |
|
|
|
|
115
|
|
|
} |
116
|
|
|
} |
117
|
|
|
|
118
|
|
|
/** |
119
|
|
|
* Retrieve an item stored in the record. |
120
|
|
|
* This method returns items that are directly stored in the model or lazy |
121
|
|
|
* loads related items. The key could be a field in the model's table or |
122
|
|
|
* the name of a related model. |
123
|
|
|
* @param string $key A key identifying the item to be retrieved. |
124
|
|
|
* @return mixed |
125
|
|
|
*/ |
126
|
|
|
private function retrieveItem($key) { |
127
|
|
|
$relationships = $this->getDescription()->getRelationships(); |
128
|
|
|
$decamelizedKey = Text::deCamelize($key); |
129
|
|
|
if (isset($relationships[$key])) { |
130
|
|
|
return $this->fetchRelatedFields($relationships[$key]); |
131
|
|
|
} |
132
|
|
|
return isset($this->modelData[$decamelizedKey]) ? $this->modelData[$decamelizedKey] : null; |
133
|
|
|
} |
134
|
|
|
|
135
|
|
|
/** |
136
|
|
|
* Create a new instance of this Model |
137
|
|
|
* @return \ntentan\nibii\RecordWrapper |
138
|
|
|
*/ |
139
|
35 |
|
public static function createNew() { |
140
|
35 |
|
$instance = ORMContext::getInstance()->getContainer()->resolve(get_called_class()); |
141
|
35 |
|
$instance->initialize(); |
142
|
1 |
|
return $instance; |
143
|
|
|
} |
144
|
|
|
|
145
|
|
|
/** |
146
|
|
|
* @method |
147
|
|
|
* @param type $name |
148
|
|
|
* @param type $arguments |
149
|
|
|
* @return type |
150
|
|
|
*/ |
151
|
1 |
|
public function __call($name, $arguments) { |
152
|
1 |
|
$this->initialize(); |
153
|
1 |
|
if ($this->dynamicOperations === null) { |
154
|
|
|
// Bind to existing instances |
155
|
1 |
|
$this->container->bind(RecordWrapper::class)->to($this); |
156
|
1 |
|
$this->dynamicOperations = $this->container->resolve( |
157
|
1 |
|
Operations::class, ['table' => $this->quotedTable, 'adapter' => $this->adapter] |
158
|
|
|
); |
159
|
|
|
// Unbind all bindings (necessary?) |
160
|
|
|
} |
161
|
1 |
|
return $this->dynamicOperations->perform($name, $arguments); |
162
|
|
|
} |
163
|
|
|
|
164
|
27 |
|
public static function __callStatic($name, $arguments) { |
165
|
27 |
|
return call_user_func_array([self::createNew(), $name], $arguments); |
166
|
|
|
} |
167
|
|
|
|
168
|
|
|
public function __set($name, $value) { |
169
|
|
|
$this->dataSet = true; |
170
|
|
|
$this->modelData[Text::deCamelize($name)] = $value; |
171
|
|
|
} |
172
|
|
|
|
173
|
|
|
public function __get($name) { |
174
|
|
|
return $this->retrieveItem($name); |
175
|
|
|
} |
176
|
|
|
|
177
|
|
|
private function expandArrayValue($array, $relationships, $depth, $index = null) { |
|
|
|
|
178
|
|
|
foreach ($relationships as $name => $relationship) { |
179
|
|
|
$array[$name] = $this->fetchRelatedFields($relationship, $index)->toArray($depth); |
180
|
|
|
} |
181
|
|
|
return $array; |
182
|
|
|
} |
183
|
|
|
|
184
|
|
|
public function toArray($depth = 0) { |
|
|
|
|
185
|
|
|
$relationships = $this->getDescription()->getRelationships(); |
186
|
|
|
$array = $this->modelData; |
187
|
|
|
if ($depth > 0) { |
188
|
|
|
if ($this->hasMultipleItems()) { |
189
|
|
|
foreach ($array as $i => $value) { |
190
|
|
|
$array[$i] = $this->expandArrayValue($value, $relationships, $depth - 1, $i); |
191
|
|
|
} |
192
|
|
|
} else { |
193
|
|
|
$array = $this->expandArrayValue($array, $relationships, $depth - 1); |
194
|
|
|
} |
195
|
|
|
} |
196
|
|
|
return $array; |
197
|
|
|
} |
198
|
|
|
|
199
|
|
|
public function save() { |
200
|
|
|
$return = $this->__call('save', [$this->hasMultipleItems()]); |
|
|
|
|
201
|
|
|
$this->invalidFields = $this->dynamicOperations->getInvalidFields(); |
202
|
|
|
return $return; |
203
|
|
|
} |
204
|
|
|
|
205
|
|
|
private function hasMultipleItems() { |
206
|
|
|
if (count($this->modelData) > 0) { |
207
|
|
|
return is_numeric(array_keys($this->modelData)[0]); |
208
|
|
|
} else { |
209
|
|
|
return false; |
210
|
|
|
} |
211
|
|
|
} |
212
|
|
|
|
213
|
|
|
public function getData() { |
214
|
|
|
$data = []; |
215
|
|
|
|
216
|
|
|
if (count($this->modelData) == 0) { |
217
|
|
|
$data = $this->modelData; |
218
|
|
|
} else if ($this->hasMultipleItems()) { |
219
|
|
|
$data = $this->modelData; |
220
|
|
|
} else if (count($this->modelData) > 0) { |
221
|
|
|
$data[] = $this->modelData; |
222
|
|
|
} |
223
|
|
|
|
224
|
|
|
return $data; |
225
|
|
|
} |
226
|
|
|
|
227
|
1 |
|
public function setData($data) { |
228
|
1 |
|
$this->dataSet = true; |
229
|
1 |
|
$this->modelData = $data; |
230
|
1 |
|
} |
231
|
|
|
|
232
|
|
|
public function mergeData($data) { |
233
|
|
|
foreach ($data as $key => $value) { |
234
|
|
|
$this->modelData[$key] = $value; |
235
|
|
|
} |
236
|
|
|
$this->dataSet = true; |
237
|
|
|
} |
238
|
|
|
|
239
|
|
|
public function offsetExists($offset) { |
240
|
|
|
return isset($this->modelData[$offset]); |
241
|
|
|
} |
242
|
|
|
|
243
|
|
|
public function offsetGet($offset) { |
244
|
|
|
if (is_numeric($offset)) { |
245
|
|
|
return $this->wrap($offset); |
246
|
|
|
} else { |
247
|
|
|
return $this->retrieveItem($offset); |
248
|
|
|
} |
249
|
|
|
} |
250
|
|
|
|
251
|
|
|
public function offsetSet($offset, $value) { |
252
|
|
|
$this->dataSet = true; |
253
|
|
|
$this->modelData[$offset] = $value; |
254
|
|
|
} |
255
|
|
|
|
256
|
|
|
public function offsetUnset($offset) { |
257
|
|
|
unset($this->modelData[$offset]); |
258
|
|
|
} |
259
|
|
|
|
260
|
|
|
private function wrap($offset) { |
261
|
|
|
if (isset($this->modelData[$offset])) { |
262
|
|
|
$newInstance = $this->createNew(); |
263
|
|
|
$newInstance->setData($this->modelData[$offset]); |
264
|
|
|
return $newInstance; |
265
|
|
|
} else { |
266
|
|
|
return null; |
267
|
|
|
} |
268
|
|
|
} |
269
|
|
|
|
270
|
|
|
public function getInvalidFields() { |
|
|
|
|
271
|
|
|
return $this->invalidFields; |
272
|
|
|
} |
273
|
|
|
|
274
|
|
|
public function getHasMany() { |
275
|
|
|
return $this->hasMany; |
276
|
|
|
} |
277
|
|
|
|
278
|
|
|
public function getBelongsTo() { |
279
|
|
|
return $this->belongsTo; |
280
|
|
|
} |
281
|
|
|
|
282
|
|
|
public function current() { |
283
|
|
|
return $this->wrap($this->keys[$this->index]); |
284
|
|
|
} |
285
|
|
|
|
286
|
|
|
public function key() { |
287
|
|
|
return $this->keys[$this->index]; |
288
|
|
|
} |
289
|
|
|
|
290
|
|
|
public function next() { |
291
|
|
|
$this->index++; |
292
|
|
|
} |
293
|
|
|
|
294
|
|
|
public function rewind() { |
295
|
|
|
$this->keys = array_keys($this->modelData); |
296
|
|
|
$this->index = 0; |
297
|
|
|
} |
298
|
|
|
|
299
|
|
|
public function valid() { |
300
|
|
|
return isset($this->keys[$this->index]) && isset($this->modelData[$this->keys[$this->index]]); |
301
|
|
|
} |
302
|
|
|
|
303
|
|
|
public function onValidate($errors) { |
|
|
|
|
304
|
|
|
return $errors; |
305
|
|
|
} |
306
|
|
|
|
307
|
|
|
private function fetchRelatedFields($relationship, $index = null) { |
|
|
|
|
308
|
|
|
if ($index === null) { |
309
|
|
|
$data = $this->modelData; |
310
|
|
|
} else { |
311
|
|
|
$data = $this->modelData[$index]; |
312
|
|
|
} |
313
|
|
|
$model = $relationship->getModelInstance(); |
314
|
|
|
if (empty($data)) { |
315
|
|
|
return $model; |
316
|
|
|
} |
317
|
|
|
$query = $relationship->prepareQuery($data); |
318
|
|
|
return $query ? $model->fetch($query) : $model; |
319
|
|
|
} |
320
|
|
|
|
321
|
|
|
public function getRelationships() { |
322
|
|
|
return [ |
323
|
|
|
'HasMany' => $this->hasMany, |
324
|
|
|
'BelongsTo' => $this->belongsTo, |
325
|
|
|
'ManyHaveMany' => $this->manyHaveMany |
326
|
|
|
]; |
327
|
|
|
} |
328
|
|
|
|
329
|
|
|
public function usetField($field) { |
330
|
|
|
unset($this->modelData[$field]); |
331
|
|
|
} |
332
|
|
|
|
333
|
|
|
public function preSaveCallback() { |
334
|
|
|
|
335
|
|
|
} |
336
|
|
|
|
337
|
|
|
public function postSaveCallback($id) { |
|
|
|
|
338
|
|
|
|
339
|
|
|
} |
340
|
|
|
|
341
|
|
|
public function preUpdateCallback() { |
342
|
|
|
|
343
|
|
|
} |
344
|
|
|
|
345
|
|
|
public function postUpdateCallback() { |
346
|
|
|
|
347
|
|
|
} |
348
|
|
|
|
349
|
1 |
|
public function getDBStoreInformation() { |
350
|
1 |
|
$this->initialize(); |
351
|
|
|
return [ |
352
|
1 |
|
'schema' => $this->schema, |
353
|
1 |
|
'table' => $this->table, |
354
|
1 |
|
'quoted_table' => $this->quotedTable, |
355
|
1 |
|
'unquoted_table' => $this->unquotedTable |
356
|
|
|
]; |
357
|
|
|
} |
358
|
|
|
|
359
|
|
|
/** |
360
|
|
|
* |
361
|
|
|
* @return DataAdapter |
|
|
|
|
362
|
|
|
*/ |
363
|
|
|
public function getAdapter() { |
364
|
|
|
$this->initialize(); |
365
|
|
|
return $this->adapter; |
366
|
|
|
} |
367
|
|
|
|
368
|
|
|
} |
369
|
|
|
|
Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it.
The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production.
This check looks for comments that seem to be mostly valid code and reports them.