-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
ResultSet.php
372 lines (328 loc) · 7.94 KB
/
ResultSet.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
<?php
/**
* PHP Version 5.4
*
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @since CakePHP(tm) v 3.0.0
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
*/
namespace Cake\ORM;
use Cake\Database\Exception;
use Cake\Database\Type;
use \Countable;
use \Iterator;
use \JsonSerializable;
use \Serializable;
/**
* Represents the results obtained after executing a query for an specific table
* This object is responsible for correctly nesting result keys reported from
* the query, casting each field to the correct type and executing the extra
* queries required for eager loading external associations.
*
*/
class ResultSet implements Countable, Iterator, Serializable, JsonSerializable {
use ResultCollectionTrait;
/**
* Original query from where results where generated
*
* @var Query
*/
protected $_query;
/**
* Database statement holding the results
*
* @var \Cake\Database\StatementInterface
*/
protected $_statement;
/**
* Points to the next record number that should be fetched
*
* @var integer
*/
protected $_index = 0;
/**
* Last record fetched from the statement
*
* @var array
*/
protected $_current;
/**
* Default table instance
*
* @var \Cake\ORM\Table
*/
protected $_defaultTable;
/**
* List of associations that should be eager loaded
*
* @var array
*/
protected $_associationMap = [];
/**
* Map of fields that are fetched from the statement with
* their type and the table they belong to
*
* @var string
*/
protected $_map;
/**
* Results that have been fetched or hydrated into the results.
*
* @var array
*/
protected $_results = [];
/**
* Whether to hydrate results into objects or not
*
* @var boolean
*/
protected $_hydrate = true;
/**
* The fully namespaced name of the class to use for hydrating results
*
* @var string
*/
protected $_entityClass;
/**
* Constructor
*
* @param Query from where results come
* @param \Cake\Database\StatementInterface $statement
* @return void
*/
public function __construct($query, $statement) {
$this->_query = $query;
$this->_statement = $statement;
$this->_defaultTable = $this->_query->repository();
$this->_calculateAssociationMap();
$this->_hydrate = $this->_query->hydrate();
$this->_entityClass = $query->repository()->entityClass();
}
/**
* Returns the current record in the result iterator
*
* @return array|object
*/
public function current() {
return $this->_current;
}
/**
* Returns the key of the current record in the iterator
*
* @return integer
*/
public function key() {
return $this->_index;
}
/**
* Advances the iterator pointer to the next record
*
* @return void
*/
public function next() {
$this->_index++;
}
/**
* Rewind a ResultSet.
*
* Not implemented, Use a BufferedResultSet for a rewindable
* ResultSet.
*
* @throws Cake\Database\Exception
*/
public function rewind() {
if ($this->_index == 0) {
return;
}
$msg = __d(
'cake_dev',
'You cannot rewind an un-buffered ResultSet. Use Query::bufferResults() to get a buffered ResultSet.'
);
throw new Exception($msg);
}
/**
* Whether there are more results to be fetched from the iterator
*
* @return boolean
*/
public function valid() {
if (isset($this->_results[$this->_index])) {
$this->_current = $this->_results[$this->_index];
return true;
}
$this->_current = $this->_fetchResult();
$valid = $this->_current !== false;
if (!$valid && $this->_statement) {
$this->_statement->closeCursor();
}
if ($valid) {
$this->_bufferResult($this->_current);
}
return $valid;
}
/**
* Returns the first result in this set and blocks the set so that no other
* results can be fetched.
*
* When using serialized results, the index will be incremented past the
* end of the results simulating the behavior when the result set is backed
* by a statement.
*
* @return array|object
*/
public function one() {
if ($this->valid()) {
if ($this->_statement) {
$this->_statement->closeCursor();
}
if (!$this->_statement && $this->_results) {
$this->_index = count($this->_results);
}
return $this->_current;
}
return null;
}
/**
* Gives the number of rows in the result set.
*
* Part of the countable interface.
*
* @return integer
*/
public function count() {
if ($this->_statement) {
return $this->_statement->rowCount();
}
return count($this->_results);
}
/**
* Calculates the list of associations that should get eager loaded
* when fetching each record
*
* @return void
*/
protected function _calculateAssociationMap() {
$contain = $this->_query->normalizedContainments();
if (!$contain) {
return;
}
$map = [];
$visitor = function($level) use (&$visitor, &$map) {
foreach ($level as $assoc => $meta) {
$map[$assoc] = [
'instance' => $meta['instance'],
'canBeJoined' => $meta['canBeJoined'],
'entityClass' => $meta['instance']->target()->entityClass()
];
if (!empty($meta['associations'])) {
$visitor($meta['associations']);
}
}
};
$visitor($contain, []);
$this->_associationMap = $map;
}
/**
* Helper function to fetch the next result from the statement or
* seeded results.
*
* @return mixed
*/
protected function _fetchResult() {
if (!$this->_statement) {
return false;
}
$row = $this->_statement->fetch('assoc');
if ($row === false) {
return $row;
}
return $this->_groupResult($row);
}
/**
* Correctly nest results keys including those coming from associations
*
* @return array
*/
protected function _groupResult($row) {
$defaultAlias = $this->_defaultTable->alias();
$results = [];
foreach ($row as $key => $value) {
$table = $defaultAlias;
$field = $key;
if (empty($this->_map[$key])) {
$parts = explode('__', $key);
if (count($parts) > 1) {
$this->_map[$key] = $parts;
}
}
if (!empty($this->_map[$key])) {
list($table, $field) = $this->_map[$key];
}
$results[$table][$field] = $value;
}
$results[$defaultAlias] = $this->_castValues(
$this->_defaultTable,
$results[$defaultAlias]
);
$options = [
'useSetters' => false,
'markClean' => true,
'markNew' => false,
'guard' => false
];
foreach (array_reverse($this->_associationMap) as $alias => $assoc) {
if (!isset($results[$alias])) {
continue;
}
$instance = $assoc['instance'];
$results[$alias] = $this->_castValues($instance->target(), $results[$alias]);
if ($this->_hydrate && $assoc['canBeJoined']) {
$entity = new $assoc['entityClass']($results[$alias], $options);
$entity->clean();
$results[$alias] = $entity;
}
$results = $instance->transformRow($results);
}
$results = $results[$defaultAlias];
if ($this->_hydrate && !($results instanceof Entity)) {
$results = new $this->_entityClass($results, $options);
}
return $results;
}
/**
* Casts all values from a row brought from a table to the correct
* PHP type.
*
* @param Table $table
* @param array $values
* @return array
*/
protected function _castValues($table, $values) {
$alias = $table->alias();
$driver = $this->_query->connection()->driver();
if (empty($this->types[$alias])) {
$schema = $table->schema();
foreach ($schema->columns() as $col) {
$this->types[$alias][$col] = Type::build($schema->columnType($col));
}
}
foreach ($values as $field => $value) {
if (!isset($this->types[$alias][$field])) {
continue;
}
$values[$field] = $this->types[$alias][$field]->toPHP($value, $driver);
}
return $values;
}
protected function _bufferResult($result) {
$this->_results[] = $result;
}
}