Spec-Zone.ru › CakePHP 3.6

Класс UuidType

Обеспечивает поведение для типа UUID

Cake\Database\Type реализует Cake\Database\TypeInterface
Расширяется Cake\Database\Type\StringType реализует Cake\Database\Type\OptionalConvertInterface, Cake\Database\TypeInterface
Расширяется Cake\Database\Type\UuidType
Пространство имён: Cake\Database\Type
Расположение: Database/Type/UuidType.php

Наследуемые свойства

  • _basicTypes, _builtTypes, _name, _types

Краткое описание методов

  • marshal() public
    Преобразует данные запроса в строку PHP
  • newId() public
    Генерирует новый UUID
  • toDatabase() public
    Преобразует заданное значение из типа PHP в тип, приемлемый для базы данных

Подробное описание методов

marshal()source public

marshal( mixed $value )

Преобразует данные запроса в строку PHP

Параметры

mixed $value
Значение для преобразования.

Возвращает

string|null
Преобразованное значение.

Переопределяет

Cake\Database\Type\StringType::marshal()

newId()source public

newId( )

Генерирует новый UUID

Возвращает

string
Новое значение первичного ключа.

Переопределяет

Cake\Database\Type::newId()

toDatabase()source public

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

Преобразует заданное значение из типа PHP в тип, приемлемый для базы данных

Параметры

mixed $value
значение, которое нужно преобразовать в базу данных эквивалент
Cake\Database\Driver $driver
объект, из которого будут извлечены настройки и конфигурация базы данных

Возвращает

string|null

Переопределяет

Cake\Database\Type\StringType::toDatabase()

Методы, унаследованные от Cake\Database\Type\StringType

requiresToPhpCast()source public

requiresToPhpCast( )

Возвращает, требуется ли преобразование в PHP, так как это не идентичная функция.

Возвращает

boolean
False, так как результаты из базы данных уже возвращаются как строки

Реализация

Cake\Database\Type\OptionalConvertInterface::requiresToPhpCast()

toPHP()source public

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

Преобразует строковые значения в строки PHP.

Параметры

mixed $value
Значение для преобразования.
Cake\Database\Driver $driver
Экземпляр драйвера для преобразования.

Возвращает

string|null

Переопределяет

Cake\Database\Type::toPHP()

Реализация

Cake\Database\TypeInterface::toPHP()

toStatement()source public

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

Получение правильного типа привязки PDO для строковых данных.

Параметры

mixed $value
Связываемое значение.
Cake\Database\Driver $driver
Драйвер.

Возвращает

integer

Переопределяет

Cake\Database\Type::toStatement()

Реализация

Cake\Database\TypeInterface::toStatement()

Методы, унаследованные от Cake\Database\Type

__construct()source public

__construct( string|null $name = null )

Конструктор

Параметры

string|null $name optional null
Имя, определяющее этот тип

__debugInfo()source public

__debugInfo( )

Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.

Возвращает

array

_basicTypeCast()source protected deprecated

_basicTypeCast( mixed $value )

Проверяет, является ли этот тип базовым и может ли он быть преобразован с помощью обратного вызова Если это так, возвращает преобразованное значение

Устарело

3.1 Все типы теперь должны быть конкретным классом

Параметры

mixed $value
Значение для преобразования в PHP эквивалент

Возвращает

mixed

boolval()source public static deprecated

boolval( mixed $value )

Преобразователь типов для логических значений.

Преобразует строковые true/false в булевые значения.

Устарело

3.1.8 Этот метод больше не используется.

Параметры

mixed $value
Значение для преобразования в булевое.

Возвращает

boolean

build()source public static

build( string $name )

Возвращает объект Type, способный преобразовывать тип, идентифицированный по имени.

Параметры

string $name
идентификатор типа

Возвращает

Cake\Database\Type

Исключения

InvalidArgumentException
Если идентификатор типа неизвестен

buildAll()source public static

buildAll( )

Возвращает массив со всеми сопоставленными объектами типа, индексированными по имени.

Возвращает

array

clear()source public static

clear( )

Очищает все созданные экземпляры и сопоставленные типы классов, полезно для тестирования

getBaseType()source public

getBaseType( )

Возвращает базовое имя типа, которое наследует этот класс.

Возвращает

string
Базовое имя типа, которое наследует этот класс.

Реализация

Cake\Database\TypeInterface::getBaseType()

getMap()source public static

getMap( string|null $type = null )

Получить имя сопоставленного класса или экземпляр для типа(ов).

Параметры

string|null $type optional null
Имя типа, для которого нужно получить сопоставленный класс, или null, чтобы получить массив отображения.

Возвращает

array|string|Cake\Database\TypeInterface|null
Настроенное имя класса или экземпляр для заданного $type или массив отображения.

С момента

3.6.2

getName()source public

getName( )

Возвращает идентификатор имени типа для этого объекта.

Возвращает

string
Идентификатор имени типа для этого объекта.

Реализация

Cake\Database\TypeInterface::getName()
END_OF_DOCUMENT_MARKER ```

map()source public static

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

Регистрирует новый идентификатор типа и сопоставляет его с полным именем класса с пространством имён, Если вызвано без аргументов, вернёт текущий массив сопоставлений типов. Если $className опущен, вернёт сопоставленный класс для $type.

Устарело с версии 3.6.2: - Использование $type как string[]|\Cake\Database\Type[] устарело. Используйте Type::setMap() со string[] вместо этого. - Передача $className как \Cake\Database\Type instance устарело; используйте только строку с именем класса. - Использование этого метода как геттера устарело. Используйте Type::getMap() вместо этого.

Параметры

string|string[]|Cake\Database\Type[]|null $type необязательный null
Если строковое имя типа для сопоставления, если массив — список массивов для сопоставления
string|Cake\Database\Type|null $className необязательный null
Имя класса или объект экземпляра для регистрации.

Возвращает

array|string|null

Если $type равен null, то массив с текущим сопоставлением, если $className равен null — строковое имя класса для данного $type, иначе — null


set()source public static

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

Возвращает объект Type, способный преобразовывать тип, определённый $name

Параметры

string $name
Идентификатор типа, который вы хотите установить.
Cake\Database\Type $instance
Экземпляр типа, который вы хотите установить.

setMap()source public static

setMap( array $map )

Устанавливает сопоставление типов с именами классов.

Параметры

array $map
Список типов для сопоставления.

Since

3.6.2

strval()source public static deprecated

strval( mixed $value )

Преобразователь типов для строковых значений.

Преобразует значения в строки

Устарело

3.1.8 Этот метод больше не используется.

Параметры

mixed $value
Значение для преобразования в строку.

Возвращает

string

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API