Docs4dev
Docs
cakephp / 3.9 / interface-cake.database.typeinterface.html

Interface TypeInterface

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

Namespace: Cake\Database

Method Summary

  • 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

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

The base type name that this class is inheriting.

getName() public

getName()

Returns type identifier name for this object.

Returns

string

The 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

mixed

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

mixed

A new primary key value.

See Also

\Cake\Database\Type\UuidType

toDatabase() 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

mixed

Given PHP type casted to one acceptable by a database.

toPHP() 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

mixed

Given value casted from a database to a PHP equivalent.

toStatement() 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

mixed

Given value casted to its Statement equivalent.

© 2005–present 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.9/interface-Cake.Database.TypeInterface.html