Class BinaryUuidType

Binary UUID type converter.

Use to convert binary uuid data between PHP and the database types.

Namespace: Cake\Database\Type

Properties summary

  • $_name protected
    string|null

    Identifier name for this type

Method Summary

Method Detail

__construct() public 

__construct(?string $name)

Constructor

Parameters

string|null $name optional

The name identifying this type

convertBinaryUuidToString() protected 

convertBinaryUuidToString(mixed $binary)

Converts a binary uuid to a string representation

Parameters

mixed $binary

The value to convert.

Returns

string

Converted value.

convertStringToBinaryUuid() protected 

convertStringToBinaryUuid(mixed $string)

Converts a string uuid to a binary representation

Parameters

string $string

The value to convert.

Returns

string

Converted value.

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|null

The base type name that this class is inheriting.

getName() public 

getName()

Returns type identifier name for this object.

Returns

string|null

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 binary UUID

Returns

string

A new primary key value.

toDatabase() public 

toDatabase(mixed $value, \Cake\Database\DriverInterface $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

mixed $value

The value to convert.

\Cake\Database\DriverInterface $driver

The driver instance to convert with.

Returns

string|resource

toPHP() public 

toPHP(mixed $value, \Cake\Database\DriverInterface $driver)

Convert binary uuid into resource handles

Parameters

mixed $value

The value to convert.

\Cake\Database\DriverInterface $driver

The driver instance to convert with.

Returns

resource|string|null

Throws

Cake\Core\Exception\Exception

toStatement() public 

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

Get the correct PDO binding type for Binary data.

Parameters

mixed $value

The value being bound.

\Cake\Database\DriverInterface $driver

The driver.

Returns

int

Property Detail

$_name protected

Identifier name for this type

Type

string|null

© 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/4.0/class-Cake.Database.Type.BinaryUuidType.html