Class BinaryType
Binary type converter.
Use to convert binary data between PHP and the database types.
Property Summary
-
$_name protected
string|nullIdentifier name for this type
Method Summary
-
__construct() public
Constructor
-
getBaseType() public
Returns the base type name that this class is inheriting.
-
getName() public
Returns type identifier name for this object.
-
marshal() public
Marshals flat data into PHP objects.
-
newId() public
Generate a new primary key value for a given type.
-
toDatabase() public
Convert binary data into the database format.
-
toPHP() public
Convert binary into resource handles
-
toStatement() public
Get the correct PDO binding type for Binary data.
Method Detail
__construct() ¶ public
__construct(string|null $name = null)Constructor
Parameters
-
string|null$name optional The name identifying this type
getBaseType() ¶ public
getBaseType(): string|nullReturns 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.
Returns
string|nullgetName() ¶ public
getName(): string|nullReturns type identifier name for this object.
Returns
string|nullmarshal() ¶ public
marshal(mixed $value): mixedMarshals 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.
Parameters
-
mixed$value The value to convert.
Returns
mixednewId() ¶ public
newId(): mixedGenerate 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.
Returns
mixedtoDatabase() ¶ public
toDatabase(mixed $value, Cake\Database\DriverInterface $driver): resource|stringConvert binary data into the database format.
Binary data is not altered before being inserted into the database. As PDO will handle reading file handles.
Parameters
-
mixed$value The value to convert.
-
Cake\Database\DriverInterface$driver The driver instance to convert with.
Returns
resource|stringtoPHP() ¶ public
toPHP(mixed $value, Cake\Database\DriverInterface $driver): resource|nullConvert binary into resource handles
Parameters
-
mixed$value The value to convert.
-
Cake\Database\DriverInterface$driver The driver instance to convert with.
Returns
resource|nullThrows
Cake\Core\Exception\CakeExceptiontoStatement() ¶ public
toStatement(mixed $value, Cake\Database\DriverInterface $driver): intGet the correct PDO binding type for Binary data.
Parameters
-
mixed$value The value being bound.
-
Cake\Database\DriverInterface$driver The driver.
Returns
int