Class BinaryType
Binary type converter.
Use to convert binary data between PHP and the database types.
- Cake\Database\Type
-
Cake\Database\Type\BinaryType
Inherited Properties
Method Summary
-
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
toDatabase() public ¶
toDatabase( string|resource $value , Cake\Database\Driver $driver )
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.
Parameters
- string|resource $value
- The value to convert.
-
Cake\Database\Driver$driver - The driver instance to convert with.
Returns
Overrides
toPHP() public ¶
toPHP( null|string|resource $value , Cake\Database\Driver $driver )
Convert binary into resource handles
Parameters
- null|string|resource $value
- The value to convert.
-
Cake\Database\Driver$driver - The driver instance to convert with.
Returns
Throws
Overrides
toStatement() public ¶
toStatement( mixed $value , Cake\Database\Driver $driver )
Get the correct PDO binding type for Binary data.
Parameters
- mixed $value
- The value being bound.
-
Cake\Database\Driver$driver - The driver.
Returns
Overrides
Methods inherited from Cake\Database\Type
__construct() public ¶
__construct( string $name = null )
Constructor
Parameters
- string $name optional null
- The name identifying this type
_basicTypeCast() protected ¶
_basicTypeCast( mixed $value )
Checks whether this type is a basic one and can be converted using a callback If it is, returns converted value
Parameters
- mixed $value
- value to be converted to PHP equivalent
Returns
boolval() public static ¶
boolval( mixed $value )
Type converter for boolean values.
Will convert string true/false into booleans.
Parameters
- mixed $value
- The value to convert to a boolean.
Returns
build() public static ¶
build( string $name )
Returns a Type object capable of converting a type identified by $name
Parameters
- string $name
- type identifier
Returns
Throws
If type identifier is unknown
clear() public static ¶
clear( )
Clears out all created instances and mapped types classes, useful for testing
getBaseType() public ¶
getBaseType( )
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.
Returns
map() public static ¶
map( string|array|null $type = null , string|null $className = null )
Registers a new type identifier and maps it to a fully namespaced classname, If called with no arguments it will return current types map array If $className is omitted it will return mapped class for $type
Parameters
- string|array|null $type optional null
- if string name of type to map, if array list of arrays to be mapped
- string|null $className optional null
- The classname to register.
Returns
if $type is null then array with current map, if $className is null string configured class name for give $type, null otherwise
marshal() public ¶
marshal( mixed $value )
Marshalls 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
Converted value.
newId() public ¶
newId( )
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.
Returns
A new primary key value.
See
set() public static ¶
set( string $name , Cake\Database\Type $instance )
Returns a Type object capable of converting a type identified by $name
Parameters
- string $name
- The type identifier you want to set.
-
Cake\Database\Type$instance - The type instance you want to set.