\Cake\DatabaseTypeInterface

Encapsulates all conversion functions for values coming from a database into PHP and going from PHP into a database.

Summary

Methods
Constants
toDatabase()
toPHP()
toStatement()
marshal()
getBaseType()
getName()
newId()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

toDatabase()

toDatabase(mixed  $value, \Cake\Database\Driver  $driver) : mixed

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

mixed —

Given PHP type casted to one acceptable by a database.

toPHP()

toPHP(mixed  $value, \Cake\Database\Driver  $driver) : mixed

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

mixed —

Given value casted from a database to a PHP equivalent.

toStatement()

toStatement(mixed  $value, \Cake\Database\Driver  $driver) : mixed

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

mixed —

Given value casted to its Statement equivalent.

marshal()

marshal(mixed  $value) : mixed

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

mixed —

Converted value.

getBaseType()

getBaseType() : string

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 —

The base type name that this class is inheriting.

getName()

getName() : string

Returns type identifier name for this object.

Returns

string —

The type identifier name for this object.

newId()

newId() : mixed

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

mixed —

A new primary key value.