-
Notifications
You must be signed in to change notification settings - Fork 337
/
result.php
369 lines (326 loc) · 6.7 KB
/
result.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
<?php
/**
* Fuel is a fast, lightweight, community driven PHP 5.4+ framework.
*
* @package Fuel
* @version 1.9-dev
* @author Fuel Development Team
* @license MIT License
* @copyright 2010 - 2019 Fuel Development Team
* @copyright 2008 - 2009 Kohana Team
* @link https://fuelphp.com
*/
namespace Fuel\Core;
abstract class Database_Result implements \Countable, \Iterator, \Sanitization
{
/**
* @var string Executed SQL for this result
*/
protected $_query;
/**
* @var resource $_result raw result resource
*/
protected $_result;
/**
* @var array $_results cached result data
*/
protected $_results;
/**
* @var mixed $_row current row
*/
protected $_row;
/**
* @var int $_total_rows total number of rows
*/
protected $_total_rows = 0;
/**
* @var int $_current_row current row number
*/
protected $_current_row = -1;
/**
* @var bool $_as_object return rows as an object or associative array
*/
protected $_as_object;
/**
* @var bool $_sanitization_enabled If this is a records data will be sanitized on get
*/
protected $_sanitization_enabled = false;
/**
* Sets the total number of rows and stores the result locally.
*
* @param mixed $result query result
* @param string $sql SQL query
* @param mixed $as_object object
*/
public function __construct($result, $sql, $as_object = null)
{
// Store the result locally
$this->_result = $result;
// Store the SQL locally
$this->_query = $sql;
if (is_object($as_object))
{
// Get the object class name
$as_object = get_class($as_object);
}
// Results as objects or associative arrays
$this->_as_object = $as_object;
}
/**
* Result destruction cleans up all open result sets.
*
* @return void
*/
abstract public function __destruct();
/**
* Get a cached database result from the current result iterator.
*
* $cachable = serialize($result->cached());
*
* @return Database_Result cache class
* @since 3.0.5
*/
abstract public function cached();
/**
* Return all of the rows in the result as an array.
*
* // Indexed array of all rows
* $rows = $result->as_array();
*
* // Associative array of rows by "id"
* $rows = $result->as_array('id');
*
* // Associative array of rows, "id" => "name"
* $rows = $result->as_array('id', 'name');
*
* @param string $key column for associative keys
* @param string $value column for values
* @return array
*/
public function as_array($key = null, $value = null)
{
$results = array();
if ($key === null and $value === null)
{
// Indexed rows
foreach ($this as $row)
{
$results[] = $row;
}
}
elseif ($key === null)
{
// Indexed columns
if ($this->_as_object)
{
foreach ($this as $row)
{
$results[] = $row->$value;
}
}
else
{
foreach ($this as $row)
{
$results[] = $row[$value];
}
}
}
elseif ($value === null)
{
// Associative rows
if ($this->_as_object)
{
foreach ($this as $row)
{
$results[$row->$key] = $row;
}
}
else
{
foreach ($this as $row)
{
$results[$row[$key]] = $row;
}
}
}
else
{
// Associative columns
if ($this->_as_object)
{
foreach ($this as $row)
{
$results[$row->$key] = $row->$value;
}
}
else
{
foreach ($this as $row)
{
$results[$row[$key]] = $row[$value];
}
}
}
$this->rewind();
return $results;
}
/**
* Return the named column from the current row.
*
* // Get the "id" value
* $id = $result->get('id');
*
* @param string $name column to get
* @param mixed $default default value if the column does not exist
*
* @return mixed
*/
public function get($name, $default = null)
{
// if out of iterator range, reset
if ( ! $this->valid())
{
$this->rewind();
}
if ($this->_as_object)
{
if (isset($this->_row->$name))
{
// sanitize the data if needed
if ( ! $this->_sanitization_enabled)
{
$result = $this->_row->$name;
}
else
{
$result = \Security::clean($this->_row->$name, null, 'security.output_filter');
}
return $result;
}
}
else
{
if (isset($this->_row[$name]))
{
// sanitize the data if needed
if ( ! $this->_sanitization_enabled)
{
$result = $this->_row[$name];
}
else
{
$result = \Security::clean($this->_row[$name], null, 'security.output_filter');
}
return $result;
}
}
return \Fuel::value($default);
}
/**
* Enable sanitization mode in the object
*
* @return $this
*/
public function sanitize()
{
$this->_sanitization_enabled = true;
return $this;
}
/**
* Disable sanitization mode in the object
*
* @return $this
*/
public function unsanitize()
{
$this->_sanitization_enabled = false;
return $this;
}
/**
* Returns the current sanitization state of the object
*
* @return bool
*/
public function sanitized()
{
return $this->_sanitization_enabled;
}
/**
* sanitizates the current row
*/
protected function _sanitizate()
{
if ( ($this->_row !== null) and $this->_sanitization_enabled)
{
$this->_row = \Security::clean($this->_row, null, 'security.output_filter');
}
}
/**************************
* Countable methods
*************************/
/**
* Implements [Countable::count], returns the total number of rows.
*
* echo count($result);
*
* @return integer
*/
#[\ReturnTypeWillChange]
public function count()/*: int*/
{
return $this->_total_rows;
}
/**************************
* Iterable methods
*************************/
/**
* Implements [Iterator::current], returns the current row.
*
* @return mixed
*/
#[\ReturnTypeWillChange]
public function current()/*: mixed*/
{
return $this->_row;
}
/**
* Implements [Iterator::key], returns the current row number.
*
* @return integer
*/
#[\ReturnTypeWillChange]
public function key()/*: mixed*/
{
return $this->_current_row;
}
/**
* Implements [Iterator::next], moves to the next row.
*/
#[\ReturnTypeWillChange]
public function next()/*: void*/
{
++$this->_current_row;
}
/**
* Implements [Iterator::rewind], sets the current row to -1.
*/
#[\ReturnTypeWillChange]
public function rewind()/*: void*/
{
// first row is zero, not one!
$this->_current_row = -1;
// advance to the first record, and load it
$this->next();
}
/**
* Implements [Iterator::valid], checks if the current row exists.
*
* @return boolean
*/
#[\ReturnTypeWillChange]
public function valid()/*: bool*/
{
return $this->_current_row >= 0 and $this->_current_row < $this->_total_rows;
}
}