/
class.cast-to-type-php4.php
497 lines (449 loc) · 13.8 KB
/
class.cast-to-type-php4.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
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
<?php
/**
* CastToType.
*
* Class to consistently cast variables to a specific type.
*
* Features:
* - Optionally allow/disallow empty strings/arrays.
* - Optionally recursively cast all values in an array to the choosen type (similar to filter_var_array() behaviour).
* - Optionally implode an array when cast to string.
*
* File: class.cast-to-type-php4.php
*
* Selective PHPCS exclusion: this file is only supposed to be loaded in PHP 4.
* In PHP 4, scope modifiers did not exist yet.
* @phpcs:disable Squiz.Scope.MethodScope
*
* @package CastToType
* @version 2.1.0
* @link https://github.com/jrfnl/PHP-cast-to-type
* @author Juliette Reinders Folmer, {@link http://www.adviesenzo.nl/ Advies en zo} -
* <casttotype@adviesenzo.nl>
* @copyright (c) 2006-2022, Advies en zo, Meedenken en -doen <casttotype@adviesenzo.nl> All rights reserved.
* @license http://www.opensource.org/licenses/lgpl-license.php GNU Lesser General Public License.
* @since 1.0
*/
if ( ! class_exists( 'CastToType' ) ) {
/**
* CastToType
*
* @package CastToType
* @version 2.1.0
* @link https://github.com/jrfnl/PHP-cast-to-type
* @author Juliette Reinders Folmer, {@link http://www.adviesenzo.nl/ Advies en zo} -
* <casttotype@adviesenzo.nl>
* @copyright (c) 2006-2022, Advies en zo, Meedenken en -doen <casttotype@adviesenzo.nl>
* All rights reserved.
* @license http://www.opensource.org/licenses/lgpl-license.php GNU Lesser General Public License.
*/
class CastToType {
/**
* Cast a value to specific variable type.
*
* @static
*
* @param mixed $value Value to cast.
* @param string $type Type to cast to.
* @param bool $array2null Optional. Whether to return null for arrays when casting to
* bool, int, float, num or string.
* If false, the individual values held in the array will recursively
* be cast to the specified type.
* Defaults to true.
* @param bool $allow_empty Optional. Whether to allow empty strings, empty arrays, empty objects.
* If false, null will be returned instead of the empty string/array/object.
* Defaults to true.
*
* @return mixed|null
*/
function cast( $value, $type, $array2null = true, $allow_empty = true ) {
// Have the expected variables been passed ?
if ( isset( $value ) === false || isset( $type ) === false ) {
return null;
}
$type = strtolower( trim( $type ) );
$valid_types = array(
'bool' => 1,
'boolean' => 1,
'int' => 1,
'integer' => 1,
'double' => 1,
'float' => 1,
'num' => 1,
'string' => 1,
'array' => 1,
'object' => 1,
);
// Check if the typing passed is valid, if not return NULL.
if ( ! isset( $valid_types[ $type ] ) ) {
return null;
}
switch ( $type ) {
case 'bool':
case 'boolean':
return CastToType::_bool( $value, $array2null, $allow_empty );
case 'integer':
case 'int':
return CastToType::_int( $value, $array2null, $allow_empty );
case 'double':
case 'float':
return CastToType::_float( $value, $array2null, $allow_empty );
case 'num':
if ( is_numeric( $value ) ) {
$value = ( ( (float) $value != (int) $value ) ? (float) $value : (int) $value );
}
else {
$value = null;
}
return $value;
case 'string':
return CastToType::_string( $value, $array2null, $allow_empty );
case 'array':
return CastToType::_array( $value, $allow_empty );
case 'object':
return CastToType::_object( $value, $allow_empty );
case 'null':
default:
return null;
}
}
/**
* Cast a value to bool.
*
* @static
*
* @param mixed $value Value to cast.
* @param bool $array2null Optional. Whether to return null for an array or to cast the
* individual values within the array to the chosen type.
* @param bool $allow_empty Optional. Whether to allow empty arrays. Only has effect
* when $array2null = false.
*
* @return bool|array|null
*/
function _bool( $value, $array2null = true, $allow_empty = true ) {
$true = array(
'1',
'true', 'True', 'TRUE',
'y', 'Y',
'yes', 'Yes', 'YES',
'on', 'On', 'ON',
);
$false = array(
'0',
'false', 'False', 'FALSE',
'n', 'N',
'no', 'No', 'NO',
'off', 'Off', 'OFF',
);
if ( is_bool( $value ) ) {
return $value;
}
elseif ( is_int( $value ) && ( $value === 0 || $value === 1 ) ) {
return (bool) $value;
}
elseif ( ( is_float( $value ) && ! is_nan( $value ) ) && ( $value === (float) 0 || $value === (float) 1 ) ) {
return (bool) $value;
}
elseif ( is_string( $value ) ) {
$value = trim( $value );
if ( in_array( $value, $true, true ) ) {
return true;
}
elseif ( in_array( $value, $false, true ) ) {
return false;
}
else {
return null;
}
}
elseif ( $array2null === false && is_array( $value ) ) {
return CastToType::recurse( $value, '_bool', $allow_empty );
}
elseif ( is_object( $value ) && get_class( $value ) === 'SplBool' ) {
if ( $value == true ) {
return true;
}
elseif ( $value == false ) {
return false;
}
else {
return null;
}
}
elseif ( is_object( $value ) && get_parent_class( $value ) === 'SplType' ) {
return CastToType::spl_helper( $value, '_bool', $array2null, $allow_empty );
}
return null;
}
/**
* Cast a value to integer.
*
* @static
*
* @param mixed $value Value to cast.
* @param bool $array2null Optional. Whether to return null for an array or to cast the
* individual values within the array to the chosen type.
* @param bool $allow_empty Optional. Whether to allow empty arrays. Only has effect
* when $array2null = false.
*
* @return int|array|null
*/
function _int( $value, $array2null = true, $allow_empty = true ) {
if ( is_int( $value ) ) {
return $value;
}
elseif ( is_float( $value ) ) {
if ( (int) $value == $value && ! is_nan( $value ) ) {
return (int) $value;
}
else {
return null;
}
}
elseif ( is_string( $value ) ) {
$value = trim( $value );
if ( $value === '' ) {
return null;
}
elseif ( ctype_digit( $value ) ) {
return (int) $value;
}
elseif ( strpos( $value, '-' ) === 0 && ctype_digit( substr( $value, 1 ) ) ) {
return (int) $value;
}
else {
return null;
}
}
elseif ( $array2null === false && is_array( $value ) ) {
return CastToType::recurse( $value, '_int', $allow_empty );
}
elseif ( is_object( $value ) && get_class( $value ) === 'SplInt' ) {
if ( (int) $value == $value ) {
return (int) $value;
}
else {
return null;
}
}
elseif ( is_object( $value ) && ( get_class( $value ) === 'SplBool' || get_class( $value ) === 'SplFloat' || get_class( $value ) === 'SplString' ) ) {
return CastToType::spl_helper( $value, '_int', $array2null, $allow_empty );
}
return null;
}
/**
* Cast a value to float.
*
* @static
*
* @param mixed $value Value to cast.
* @param bool $array2null Optional. Whether to return null for an array or to cast the
* individual values within the array to the chosen type.
* @param bool $allow_empty Optional. Whether to allow empty arrays. Only has effect
* when $array2null = false.
*
* @return float|array|null
*/
function _float( $value, $array2null = true, $allow_empty = true ) {
if ( is_float( $value ) ) {
return $value;
}
elseif ( $array2null === false && is_array( $value ) ) {
return CastToType::recurse( $value, '_float', $allow_empty );
}
elseif ( is_scalar( $value ) && ( is_numeric( trim( $value ) ) && ( floatval( $value ) == trim( $value ) ) ) ) {
return floatval( $value );
}
elseif ( is_object( $value ) && get_class( $value ) === 'SplFloat' ) {
if ( (float) $value == $value ) {
return (float) $value;
}
else {
return null;
}
}
elseif ( is_object( $value ) && ( get_class( $value ) === 'SplBool' || get_class( $value ) === 'SplInt' || get_class( $value ) === 'SplString' ) ) {
return CastToType::spl_helper( $value, '_float', $array2null, $allow_empty );
}
return null;
}
/**
* Cast a value to string.
*
* @static
*
* @param mixed $value Value to cast.
* @param bool $array2null Optional. Whether to return null for an array or to cast the
* individual values within the array to the chosen type.
* @param bool $allow_empty Optional. Whether to allow empty strings/arrays/objects.
*
* @return string|array|null
*/
function _string( $value, $array2null = true, $allow_empty = true ) {
if ( is_string( $value ) && ( $value !== '' || $allow_empty === true ) ) {
return $value;
}
elseif ( is_int( $value ) || is_float( $value ) ) {
return strval( $value );
}
elseif ( $array2null === false && is_array( $value ) ) {
return CastToType::recurse( $value, '_string', $allow_empty );
}
elseif ( is_object( $value ) && get_parent_class( $value ) === 'SplType' ) {
if ( (string) $value == $value ) {
return (string) $value;
}
else {
return null;
}
}
elseif ( is_object( $value ) && method_exists( $value, '__toString' ) ) {
return (string) $value;
}
return null;
}
/**
* Cast a value to array.
*
* @static
*
* @param mixed $value Value to cast.
* @param bool $allow_empty Optional. Whether to allow empty strings/arrays/objects.
*
* @return array|null
*/
function _array( $value, $allow_empty = true ) {
if ( is_array( $value ) !== true ) {
$value = (array) $value;
}
if ( count( $value ) > 0 || $allow_empty === true ) {
return $value;
}
return null;
}
/**
* Cast a value to object.
*
* Please note: in a normal array to object cast pre-PHP7, array values with numerical keys are 'lost'.
* This method checks whether the array contains numerical keys, if it doesn't it will do a
* normal array to object cast. If it does, it will cast each numerically indexes value to a numerical
* property, similar to the behaviour in PHP7.
*
* @static
*
* @param mixed $value Value to cast.
* @param bool $allow_empty Optional. Whether to allow empty strings/arrays/objects.
*
* @return object|null
*/
function _object( $value, $allow_empty = true ) {
if ( $allow_empty === false && ( is_string( $value ) && $value === '' ) ) {
return null;
}
if ( is_array( $value ) === true ) {
$has_num_keys = false;
foreach ( $value as $k => $v ) {
if ( is_int( $k ) ) {
$has_num_keys = true;
break;
}
}
if ( $has_num_keys === false ) {
$value = (object) $value;
}
else {
$new_value = new stdClass();
foreach ( $value as $k => $v ) {
$new_value->$k = $v;
}
$value = $new_value;
unset( $new_value, $k, $v );
}
}
elseif ( is_object( $value ) !== true ) {
$value = (object) $value;
}
if ( $allow_empty === false ) {
$methods = get_class_methods( $value );
$properties = get_object_vars( $value );
if ( ( is_null( $methods ) || count( $methods ) === 0 ) && ( is_null( $properties ) || count( $properties ) === 0 ) ) {
// No methods or properties found.
$value = null;
}
}
return $value;
}
/**
* Cast a value to null (for completeness).
*
* @static
*
* @return null
*/
function _null() {
return null;
}
/**
* Recurse through an array.
*
* @static
* @internal
*
* @param array $value Array holding values to cast.
* @param string $method Calling method, i.e. cast to which type of variable.
* Can only be _bool, _int, _float or _string.
* @param bool $allow_empty Optional. Whether to allow empty arrays in the return.
*
* @return array|null
*/
function recurse( $value, $method, $allow_empty = true ) {
if ( is_array( $value ) ) {
if ( count( $value ) === 0 ) {
if ( $allow_empty === true ) {
return $value;
}
else {
return null;
}
}
else {
foreach ( $value as $k => $v ) {
$value[ $k ] = CastToType::$method( $v, false, $allow_empty );
}
return $value;
}
}
return null;
}
/**
* Cast an SPL object to scalar.
*
* @static
*
* @since 2.0
*
* @param \SplType $value Value to cast.
* @param string $method Calling method, i.e. cast to which type of variable.
* Can only be _bool, _int, _float or _string.
* @param bool $array2null Optional. Whether to return null for an array or to cast the
* individual values within the array to the chosen type.
* @param bool $allow_empty Optional. Whether to allow empty strings/arrays/objects.
*
* @return bool|int|float|string|null
*/
function spl_helper( $value, $method, $array2null = true, $allow_empty = true ) {
switch ( get_class( $value ) ) {
case 'SplBool':
return CastToType::$method( (bool) $value, $array2null, $allow_empty );
case 'SplInt':
return CastToType::$method( (int) $value, $array2null, $allow_empty );
case 'SplFloat':
return CastToType::$method( (float) $value, $array2null, $allow_empty );
case 'SplString':
return CastToType::$method( (string) $value, $array2null, $allow_empty );
default:
return null;
}
}
}
}