-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
FloatType.php
195 lines (175 loc) · 5 KB
/
FloatType.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
<?php
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://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. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 3.0.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Database\Type;
use Cake\Database\Driver;
use Cake\Database\Type;
use Cake\Database\TypeInterface;
use Cake\Database\Type\BatchCastingInterface;
use PDO;
use RuntimeException;
/**
* Float type converter.
*
* Use to convert float/decimal data between PHP and the database types.
*/
class FloatType extends Type implements TypeInterface, BatchCastingInterface
{
/**
* Identifier name for this type.
*
* (This property is declared here again so that the inheritance from
* Cake\Database\Type can be removed in the future.)
*
* @var string|null
*/
protected $_name;
/**
* Constructor.
*
* (This method is declared here again so that the inheritance from
* Cake\Database\Type can be removed in the future.)
*
* @param string|null $name The name identifying this type
*/
public function __construct($name = null)
{
$this->_name = $name;
}
/**
* The class to use for representing number objects
*
* @var string
*/
public static $numberClass = 'Cake\I18n\Number';
/**
* Whether numbers should be parsed using a locale aware parser
* when marshalling string inputs.
*
* @var bool
*/
protected $_useLocaleParser = false;
/**
* Convert integer data into the database format.
*
* @param string|resource $value The value to convert.
* @param \Cake\Database\Driver $driver The driver instance to convert with.
* @return float|null
*/
public function toDatabase($value, Driver $driver)
{
if ($value === null || $value === '') {
return null;
}
return (float)$value;
}
/**
* Convert float values to PHP integers
*
* @param null|string|resource $value The value to convert.
* @param \Cake\Database\Driver $driver The driver instance to convert with.
* @return float|null
* @throws \Cake\Core\Exception\Exception
*/
public function toPHP($value, Driver $driver)
{
if ($value === null) {
return null;
}
return (float)$value;
}
/**
* {@inheritDoc}
*
* @return array
*/
public function manyToPHP(array $values, array $fields, Driver $driver)
{
foreach ($fields as $field) {
if (!isset($values[$field])) {
continue;
}
$values[$field] = (float)$values[$field];
}
return $values;
}
/**
* Get the correct PDO binding type for integer data.
*
* @param mixed $value The value being bound.
* @param \Cake\Database\Driver $driver The driver.
* @return int
*/
public function toStatement($value, Driver $driver)
{
return PDO::PARAM_STR;
}
/**
* Marshalls request data into PHP floats.
*
* @param mixed $value The value to convert.
* @return float|null Converted value.
*/
public function marshal($value)
{
if ($value === null || $value === '') {
return null;
}
if (is_numeric($value)) {
return (float)$value;
}
if (is_string($value) && $this->_useLocaleParser) {
return $this->_parseValue($value);
}
if (!is_scalar($value)) {
return null;
}
return $value;
}
/**
* Sets whether or not to parse numbers passed to the marshal() function
* by using a locale aware parser.
*
* @param bool $enable Whether or not to enable
* @return $this
*/
public function useLocaleParser($enable = true)
{
if ($enable === false) {
$this->_useLocaleParser = $enable;
return $this;
}
if (static::$numberClass === 'Cake\I18n\Number' ||
is_subclass_of(static::$numberClass, 'Cake\I18n\Number')
) {
$this->_useLocaleParser = $enable;
return $this;
}
throw new RuntimeException(
sprintf('Cannot use locale parsing with the %s class', static::$numberClass)
);
}
/**
* Converts a string into a float point after parsing it using the locale
* aware parser.
*
* @param string $value The value to parse and convert to an float.
* @return float
*/
protected function _parseValue($value)
{
$class = static::$numberClass;
return $class::parseFloat($value);
}
}