Class BinaryUuidType

__construct()source public

__construct( string|null $name = null )

Constructor.

(This method is declared here again so that the inheritance from Cake\Database\Type can be removed in the future.)

Parameters

string|null $name optional null

The name identifying this type

Overrides

Cake\Database\Type::__construct()

convertBinaryUuidToString()source protected

convertBinaryUuidToString( mixed $binary )

Converts a binary uuid to a string representation

Parameters

mixed $binary

The value to convert.

Returns

string
Converted value.

convertStringToBinaryUuid()source protected

convertStringToBinaryUuid( mixed $string )

Converts a string uuid to a binary representation

Parameters

mixed $string

The value to convert.

Returns

mixed
Converted value.

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

mixed
Converted value.

Overrides

Cake\Database\Type::marshal()

Implementation of

Cake\Database\TypeInterface::marshal()

newId()source public

newId( )

Generate a new binary UUID

Returns

string
A new primary key value.

Overrides

Cake\Database\Type::newId()

Implementation of

Cake\Database\TypeInterface::newId()

toDatabase()source public

toDatabase( string|resource $value , Cake\Database\Driver $driver )

Convert binary uuid data into the database format.

Binary data is not altered before being inserted into the database. As PDO will handle reading file handles.

Parameters

string|resource $value

The value to convert.

Cake\Database\Driver $driver

The driver instance to convert with.

Returns

string|resource

Overrides

Cake\Database\Type::toDatabase()

Implementation of

Cake\Database\TypeInterface::toDatabase()

toPHP()source public

toPHP( null|string|resource $value , Cake\Database\Driver $driver )

Convert binary uuid into resource handles

Parameters

null|string|resource $value

The value to convert.

Cake\Database\Driver $driver

The driver instance to convert with.

Returns

resource|string|null

Throws

Cake\Core\Exception\Exception

Overrides

Cake\Database\Type::toPHP()

Implementation of

Cake\Database\TypeInterface::toPHP()

toStatement()source public

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

Get the correct PDO binding type for Binary data.

Parameters

mixed $value

The value being bound.

Cake\Database\Driver $driver

The driver.

Returns

integer

Overrides

Cake\Database\Type::toStatement()

Implementation of

Cake\Database\TypeInterface::toStatement()

__debugInfo()source public

__debugInfo( )

Returns an array that can be used to describe the internal state of this object.

Returns

array

_basicTypeCast()source protected deprecated

_basicTypeCast( mixed $value )

Checks whether this type is a basic one and can be converted using a callback If it is, returns converted value

Deprecated

3.1 All types should now be a specific class

Parameters

mixed $value

Value to be converted to PHP equivalent

Returns

mixed

boolval()source public static deprecated

boolval( mixed $value )

Type converter for boolean values.

Will convert string true/false into booleans.

Deprecated

3.1.8 This method is now unused.

Parameters

mixed $value

The value to convert to a boolean.

Returns

boolean

build()source public static

build( string $name )

Returns a Type object capable of converting a type identified by name.

Parameters

string $name

type identifier

Returns

Cake\Database\Type

Throws

InvalidArgumentException
If type identifier is unknown

buildAll()source public static

buildAll( )

Returns an arrays with all the mapped type objects, indexed by name.

Returns

array

clear()source public static

clear( )

Clears out all created instances and mapped types classes, useful for testing

getBaseType()source public

getBaseType( )

Returns the base type name that this class is inheriting.

Returns

string
The base type name that this class is inheriting.

Implementation of

Cake\Database\TypeInterface::getBaseType()

getMap()source public static

getMap( string|null $type = null )

Get mapped class name or instance for type(s).

Parameters

string|null $type optional null

Type name to get mapped class for or null to get map array.

Returns

array|string|Cake\Database\TypeInterface|null
Configured class name or instance for give $type or map array.

Since

3.6.2

getName()source public

getName( )

Returns type identifier name for this object.

Returns

string
The type identifier name for this object.

Implementation of

Cake\Database\TypeInterface::getName()

map()source public static

map( string|string[]|Cake\Database\Type[]|null $type = null , string|Cake\Database\Type|null $className = null )

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

Deprecated 3.6.2: - The usage of $type as string[]|\Cake\Database\Type[] is deprecated. Use Type::setMap() with string[] instead. - Passing $className as \Cake\Database\Type instance is deprecated, use class name string only. - Using this method as getter is deprecated. Use Type::getMap() instead.

Parameters

string|string[]|Cake\Database\Type[]|null $type optional null

If string name of type to map, if array list of arrays to be mapped

string|Cake\Database\Type|null $className optional null

The classname or object instance of it to register.

Returns

array|string|null

If $type is null then array with current map, if $className is null string configured class name for give $type, null otherwise

set()source public static

set( string $name , Cake\Database\Type $instance )

Returns 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.

setMap()source public static

setMap( array $map )

Set type to classname mapping.

Parameters

array $map

List of types to be mapped.

Since

3.6.2

strval()source public static deprecated

strval( mixed $value )

Type converter for string values.

Will convert values into strings

Deprecated

3.1.8 This method is now unused.

Parameters

mixed $value

The value to convert to a string.

Returns

string