Class BinaryType
Binary type converter.
Use to convert binary data between PHP and the database types.
Property Summary
-
$_basicTypes protected static
arrayList of basic type mappings, used to avoid having to instantiate a class for doing conversion on these
-
$_builtTypes protected static
arrayContains a map of type object instances to be reused if needed
-
$_name protected
stringIdentifier name for this type
-
$_types protected static
arrayList of supported database types. A human readable identifier is used as key and a complete namespaced class name as value representing the class that will do actual type conversions.
Method Summary
-
__construct() public
Constructor
-
_basicTypeCast() protected
Checks whether this type is a basic one and can be converted using a callback If it is, returns converted value
-
boolval() public static
Type converter for boolean values.
-
build() public static
Returns a Type object capable of converting a type identified by $name
-
clear() public static
Clears out all created instances and mapped types classes, useful for testing
-
getBaseType() public
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.
-
getName() public
Returns type identifier name for this object
-
map() public static
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
-
marshal() public
Marshalls flat data into PHP objects.
-
newId() public
Generate a new primary key value for a given type.
-
set() public static
Returns a Type object capable of converting a type identified by $name
-
strval() public static
Type converter for string values.
-
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 $name = null)Constructor
Parameters
-
string$name optional The name identifying this type
_basicTypeCast() ¶ protected
_basicTypeCast(mixed $value): mixedChecks 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
mixedboolval() ¶ public static
boolval(mixed $value): boolType converter for boolean values.
Will convert string true/false into booleans.
Parameters
-
mixed$value The value to convert to a boolean.
Returns
boolbuild() ¶ public static
build(string $name): TypeReturns a Type object capable of converting a type identified by $name
Parameters
-
string$name type identifier
Returns
TypeThrows
InvalidArgumentExceptionIf type identifier is unknown
clear() ¶ public static
clear(): voidClears out all created instances and mapped types classes, useful for testing
Returns
voidgetBaseType() ¶ public
getBaseType(): stringReturns 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
stringmap() ¶ public static
map(string|array|null $type = null, string|null $className = null): array|string|nullRegisters 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 if string name of type to map, if array list of arrays to be mapped
-
string|null$className optional The classname to register.
Returns
array|string|nullmarshal() ¶ public
marshal(mixed $value): mixedMarshalls 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
mixedSee Also
set() ¶ public static
set(string $name, Cake\Database\Type $instance): voidReturns 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.
Returns
voidstrval() ¶ public static
strval(mixed $value): boolType converter for string values.
Will convert values into strings
Parameters
-
mixed$value The value to convert to a string.
Returns
booltoDatabase() ¶ public
toDatabase(mixed $value, Driver $driver): string|resourceConvert 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.
-
Driver$driver The driver instance to convert with.
Returns
string|resourcetoPHP() ¶ public
toPHP(mixed $value, Driver $driver): resource|nullConvert binary into resource handles
Parameters
-
mixed$value The value to convert.
-
Driver$driver The driver instance to convert with.
Returns
resource|nullThrows
Cake\Core\Exception\ExceptiontoStatement() ¶ public
toStatement(mixed $value, Driver $driver): intGet the correct PDO binding type for Binary data.
Parameters
-
mixed$value The value being bound.
-
Driver$driver The driver.
Returns
intProperty Detail
$_basicTypes ¶ protected static
List of basic type mappings, used to avoid having to instantiate a class for doing conversion on these
Type
array$_builtTypes ¶ protected static
Contains a map of type object instances to be reused if needed
Type
array$_types ¶ protected static
List of supported database types. A human readable identifier is used as key and a complete namespaced class name as value representing the class that will do actual type conversions.
Type
array