Interface TypeInterface
Encapsulates all conversion functions for values coming from a database into PHP and going from PHP into a database.
Direct Implementers
- Cake\Database\Type
- Cake\Database\Type\BinaryType
- Cake\Database\Type\BoolType
- Cake\Database\Type\DateTimeType
- Cake\Database\Type\DecimalType
- Cake\Database\Type\FloatType
- Cake\Database\Type\IntegerType
- Cake\Database\Type\JsonType
- Cake\Database\Type\StringType
Indirect Implementers
Method Summary
- getBaseType() publicReturns the base type name that this class is inheriting.
- getName() publicReturns type identifier name for this object.
- marshal() publicMarshalls flat data into PHP objects.
- newId() publicGenerate a new primary key value for a given type.
- toDatabase() publicCasts given value from a PHP type to one acceptable by a database.
- toPHP() publicCasts given value from a database type to a PHP equivalent.
- toStatement() publicCasts given value to its Statement equivalent.
Method Detail
getBaseType()source 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
stringThe base type name that this class is inheriting.
getName()source public
getName( )
Returns type identifier name for this object.
Returns
stringThe type identifier name for this object.
marshal()source 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
mixedConverted value.
newId()source 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
Cake\Database\Type\UuidType
toDatabase()source public
toDatabase( mixed $value , Cake\Database\Driver $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\Driver
$driver
- Object from which database preferences and configuration will be extracted.
Returns
mixedGiven PHP type casted to one acceptable by a database.
toPHP()source public
toPHP( mixed $value , Cake\Database\Driver $driver )
Casts given value from a database type to a PHP equivalent.
Parameters
- mixed
$value
- Value to be converted to PHP equivalent
-
Cake\Database\Driver
$driver
- Object from which database preferences and configuration will be extracted
Returns
mixedGiven value casted from a database to a PHP equivalent.
toStatement()source public
toStatement( mixed $value , Cake\Database\Driver $driver )
Casts given value to its Statement equivalent.
Parameters
- mixed
$value
- Value to be converted to PDO statement.
-
Cake\Database\Driver
$driver
- Object from which database preferences and configuration will be extracted.
Returns
mixedGiven value casted to its Statement equivalent.
© 2005–2017 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/3.4/class-Cake.Database.TypeInterface.html