Binary type converter.
Use to convert binary data between PHP and the database types.
string|null
Identifier name for this type
Constructor
Returns the base type name that this class is inheriting.
Returns type identifier name for this object.
Marshals flat data into PHP objects.
Generate a new primary key value for a given type.
Convert binary data into the database format.
Convert binary into resource handles
Get the correct PDO binding type for Binary data.
__construct(string|null $name = null)
Constructor
string|null
$name optional The name identifying this type
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
marshal(mixed $value): mixed
Marshals flat data into PHP objects.
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.
mixed
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): resource|string
Convert binary data into the database format.
Binary data is not altered before being inserted into the database. As PDO will handle reading file handles.
mixed
$value The value to convert.
Cake\Database\DriverInterface
$driver The driver instance to convert with.
resource|string
toPHP(mixed $value, Cake\Database\DriverInterface $driver): resource|null
Convert binary into resource handles
mixed
$value The value to convert.
Cake\Database\DriverInterface
$driver The driver instance to convert with.
resource|null
Cake\Core\Exception\CakeException
toStatement(mixed $value, Cake\Database\DriverInterface $driver): int
Get the correct PDO binding type for Binary data.
mixed
$value The value being bound.
Cake\Database\DriverInterface
$driver The driver.
int
Identifier name for this type
string|null
© 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.BinaryType.html