Class BaseType
Base type class.
Properties 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
Casts given value from a PHP type to one acceptable by a database.
-
toPHP() public
Casts given value from a database type to a PHP equivalent.
-
toStatement() public
Casts given value to its Statement equivalent.
Method Detail
__construct() public ¶
__construct(?string $name)
Constructor
Parameters
-
string|null$name optional The name identifying this type
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
string|nullThe base type name that this class is inheriting.
getName() public ¶
getName()
Returns type identifier name for this object.
Returns
string|nullThe type identifier name for this object.
marshal() public ¶
marshal(mixed $value)
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.
Parameters
-
mixed$value The value to convert.
Returns
mixedConverted 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
mixedA new primary key value.
See Also
toDatabase() public ¶
toDatabase(mixed $value, \Cake\Database\DriverInterface $driver)
Casts given value from a PHP type to one acceptable by a database.
Parameters
-
mixed$value Value to be converted to a database equivalent.
-
\Cake\Database\DriverInterface$driver Object from which database preferences and configuration will be extracted.
Returns
mixedGiven PHP type casted to one acceptable by a database.
toPHP() public ¶
toPHP(mixed $value, \Cake\Database\DriverInterface $driver)
Casts given value from a database type to a PHP equivalent.
Parameters
-
mixed$value Value to be converted to PHP equivalent
-
\Cake\Database\DriverInterface$driver Object from which database preferences and configuration will be extracted
Returns
mixedGiven value casted from a database to a PHP equivalent.
toStatement() public ¶
toStatement(mixed $value, \Cake\Database\DriverInterface $driver)
Casts given value to its Statement equivalent.
Parameters
-
mixed$value Value to be converted to PDO statement.
-
\Cake\Database\DriverInterface$driver Object from which database preferences and configuration will be extracted.
Returns
mixedGiven value casted to its Statement equivalent.