Decimal type converter.
Use to convert decimal data between PHP and the database types.
string|null
Identifier name for this type
bool
Whether numbers should be parsed using a locale aware parser when marshalling string inputs.
string
The class to use for representing number objects
Constructor
Converts localized string into a decimal string after parsing it using the locale aware parser.
Returns the base type name that this class is inheriting.
Returns type identifier name for this object.
Returns an array of the values converted to the PHP representation of this type.
Marshalls request data into decimal strings.
Generate a new primary key value for a given type.
Convert decimal strings into the database format.
Casts given value from a database type to a PHP equivalent.
Get the correct PDO binding type for decimal data.
Sets whether to parse numbers passed to the marshal() function by using a locale aware parser.
__construct(string|null $name = null)
Constructor
string|null
$name optional The name identifying this type
_parseValue(string $value): string
Converts localized string into a decimal string after parsing it using the locale aware parser.
string
$value The value to parse and convert to an float.
string
getBaseType(): string|null
Returns the base type name that this class is inheriting.
This is useful when extending base type for adding extra functionality, but still want the rest of the framework to use the same assumptions it would do about the base type it inherits from.
string|null
getName(): string|null
Returns type identifier name for this object.
string|null
manyToPHP(array $values, array<string> $fields, Cake\Database\DriverInterface $driver): array<string, mixed>
Returns an array of the values converted to the PHP representation of this type.
array
$values array<string>
$fields Cake\Database\DriverInterface
$driver array<string, mixed>
marshal(mixed $value): string|null
Marshalls request data into decimal strings.
Most useful for converting request data into PHP objects, that make sense for the rest of the ORM/Database layers.
mixed
$value The value to convert.
string|null
newId(): mixed
Generate a new primary key value for a given type.
This method can be used by types to create new primary key values when entities are inserted.
mixed
toDatabase(mixed $value, Cake\Database\DriverInterface $driver): string|float|int|null
Convert decimal strings into the database format.
mixed
$value The value to convert.
Cake\Database\DriverInterface
$driver The driver instance to convert with.
string|float|int|null
InvalidArgumentException
toPHP(mixed $value, Cake\Database\DriverInterface $driver): string|null
Casts given value from a database type to a PHP equivalent.
mixed
$value The value to convert.
Cake\Database\DriverInterface
$driver The driver instance to convert with.
string|null
toStatement(mixed $value, Cake\Database\DriverInterface $driver): int
Get the correct PDO binding type for decimal data.
mixed
$value The value being bound.
Cake\Database\DriverInterface
$driver The driver.
int
useLocaleParser(bool $enable = true): $this
Sets whether to parse numbers passed to the marshal() function by using a locale aware parser.
bool
$enable optional Whether to enable
$this
RuntimeException
Identifier name for this type
string|null
Whether numbers should be parsed using a locale aware parser when marshalling string inputs.
bool
The class to use for representing number objects
string
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.4/class-Cake.Database.Type.DecimalType.html