Класс BinaryUuidType
Конвертер типа Binary UUID.
Используется для преобразования данных бинарного uuid между PHP и типами баз данных.
- Cake\Database\Type реализует Cake\Database\TypeInterface
-
Cake\Database\Type\BinaryUuidType реализует Cake\Database\TypeInterface
Краткое описание свойств
-
$_nameprotectedИмя идентификатора для этого типа.string|null
Наследуемые свойства
Краткое описание методов
- __construct() publicКонструктор.
- convertBinaryUuidToString() protectedПреобразует бинарный uuid в строковое представление
- convertStringToBinaryUuid() protectedПреобразует строковый uuid в бинарное представление
- marshal() publicПреобразует плоские данные в объекты PHP.
- newId() publicГенерирует новый бинарный UUID
- toDatabase() publicПреобразует данные бинарного uuid в формат базы данных.
- toPHP() publicПреобразует бинарный uuid в дескрипторы ресурсов
- toStatement() publicПолучение правильного типа привязки PDO для бинарных данных.
Подробное описание методов
__construct()source public
__construct( string|null $name = null )
Конструктор.
(Этот метод объявлен здесь повторно, чтобы в будущем можно было удалить наследование от Cake\Database\Type.)
Параметры
- string|null
$nameнеобязательно null - Имя, идентифицирующее этот тип
Переопределяет
Cake\Database\Type::__construct() convertBinaryUuidToString()source protected
convertBinaryUuidToString( mixed $binary )
Преобразует бинарный uuid в строковое представление
Параметры
- mixed
$binary - Значение для преобразования.
Возвращает
строкаПреобразованное значение.
convertStringToBinaryUuid()source protected
convertStringToBinaryUuid( mixed $string )
Преобразует строковый uuid в бинарное представление
Параметры
- mixed
$string - Значение для преобразования.
Возвращает
смешанноеПреобразованное значение.
marshal()source public
marshal( mixed $value )
Преобразует плоские данные в объекты PHP.
Наиболее полезно для преобразования данных запроса в объекты PHP, которые имеют смысл для остальных слоёв ORM/Базы данных.
Параметры
- mixed
$value - Значение для преобразования.
Возвращает
смешанноеПреобразованное значение.
Переопределяет
Cake\Database\Type::marshal() Реализация
Cake\Database\TypeInterface::marshal() newId()source public
newId( )
Генерирует новый бинарный UUID
Возвращает
строкаНовое значение первичного ключа.
Переопределяет
Cake\Database\Type::newId() Реализация
Cake\Database\TypeInterface::newId() toDatabase()source public
toDatabase( string|resource $value , Cake\Database\Driver $driver )
Преобразует данные бинарного uuid в формат базы данных.
Бинарные данные не изменяются перед вставкой в базу данных. PDO будет обрабатывать чтение дескрипторов файлов.
Параметры
- строка|ресурс
$value - Значение для преобразования.
-
Cake\Database\Driver$driver - Экземпляр драйвера для преобразования.
Возвращает
строка|ресурсПереопределяет
Cake\Database\Type::toDatabase() Реализация
Cake\Database\TypeInterface::toDatabase() toPHP()source public
toPHP( null|string|resource $value , Cake\Database\Driver $driver )
Преобразует бинарный uuid в дескрипторы ресурсов
Параметры
- null|строка|ресурс
$value - Значение для преобразования.
-
Cake\Database\Driver$driver - Экземпляр драйвера для преобразования.
Возвращает
ресурс|строка|nullИсключения
Cake\Core\Exception\ExceptionПереопределяет
Cake\Database\Type::toPHP() Реализация
Cake\Database\TypeInterface::toPHP() toStatement()source public
toStatement( mixed $value , Cake\Database\Driver $driver )
Получение правильного типа привязки PDO для бинарных данных.
Параметры
- смешанное
$value - Связываемое значение.
-
Cake\Database\Driver$driver - Драйвер.
Возвращает
целое числоПереопределяет
Cake\Database\Type::toStatement() Реализация
Cake\Database\TypeInterface::toStatement() Наследуемые методы из Cake\Database\Type
__debugInfo()source public
__debugInfo( )
Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.
Возвращает
массив_basicTypeCast()source protected deprecated
_basicTypeCast( mixed $value )
Проверяет, является ли этот тип основным и можно ли преобразовать его с помощью обратного вызова. Если это так, возвращает преобразованное значение
Устарело
3.1 Все типы теперь должны быть конкретным классомПараметры
- смешанное
$value - Значение, которое необходимо преобразовать в PHP-эквивалент
Возвращает
смешанноеboolval()source public static deprecated
boolval( mixed $value )
Конвертер типа для логических значений.
Преобразует строки true/false в булевы значения.
Устарело
3.1.8 Этот метод больше не используется.Параметры
- смешанное
$value - Значение, которое необходимо преобразовать в булево значение.
Возвращает
булевоbuild()source public static
build( string $name )
Возвращает объект Type, способный преобразовывать тип, идентифицированный по имени.
Параметры
- строка
$name - идентификатор типа
Возвращает
Cake\Database\TypeИсключения
InvalidArgumentExceptionЕсли идентификатор типа неизвестен
buildAll()source public static
buildAll( )
Возвращает массив со всеми сопоставленными объектами типа, индексированными по имени.
Возвращает
массив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опционально null - Имя типа, для которого нужно получить отображённый класс, или null для получения массива отображений.
Возвращает
array|string|Cake\Database\TypeInterface|nullНастроенное имя класса или экземпляр для данного $type или массив отображений.
С
3.6.2getName()source public
getName( )
Возвращает имя идентификатора типа для этого объекта.
Возвращает
stringИмя идентификатора типа для этого объекта.
Реализация
Cake\Database\TypeInterface::getName() 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 устарела, используйте только строку имени класса. - Использование этого метода в качестве геттера устарело. Используйте 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 - Список типов для сопоставления.
С
3.6.2strval()source public static устаревший
strval( mixed $value )
Преобразователь типов для строковых значений.
Преобразует значения в строки
Устаревшее
3.1.8 Этот метод больше не используется.Параметры
- mixed
$value - Значение, которое нужно преобразовать в строку.
Возвращает
stringПодробное описание свойств
$_namesource
защищённый string|null
Имя идентификатора для этого типа.
(Это свойство объявлено здесь снова, чтобы в будущем можно было удалить наследование от Cake\Database\Type.)
© 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.8/class-Cake.Database.Type.BinaryUuidType.html