Класс BinaryType
Конвертер двоичного типа.
Используется для преобразования двоичных данных между PHP и типами баз данных.
- Cake\Database\Type implements Cake\Database\TypeInterface
-
Cake\Database\Type\BinaryType implements Cake\Database\TypeInterface
Краткое описание свойств
-
$_nameprotectedИмя идентификатора для этого типа.string|null
Унаследованные свойства
Краткое описание методов
- __construct() publicКонструктор.
- marshal() publicПреобразует плоские данные в объекты PHP.
- toDatabase() publicПреобразование двоичных данных в формат базы данных.
- toPHP() publicПреобразование двоичных данных в дескрипторы ресурсов.
- toStatement() publicПолучение правильного типа привязки PDO для двоичных данных.
Подробное описание методов
__construct()source public
__construct( string|null $name null )
Конструктор.
(Этот метод объявлен здесь снова, чтобы в будущем можно было удалить наследование от Cake\Database\Type.)
Параметры
- string|null
$nameнеобязательный null - Имя, идентифицирующее этот тип
Переопределяет
Cake\Database\Type::__construct() marshal()source public
marshal( mixed $value )
Преобразует плоские данные в объекты PHP.
Наиболее полезно для преобразования данных запроса в объекты PHP, которые имеют смысл для остальных слоев ORM/базы данных.
Параметры
- mixed
$value - Значение для преобразования.
Возвращает
mixedПреобразованное значение.
Переопределяет
Cake\Database\Type::marshal() Реализация
Cake\Database\TypeInterface::marshal() toDatabase()source public
toDatabase( string|resource $value , Cake\Database\Driver $driver )
Преобразование двоичных данных в формат базы данных.
Двоичные данные не изменяются перед вставкой в базу данных. PDO будет обрабатывать чтение дескрипторов файлов.
Параметры
- string|resource
$value - Значение для преобразования.
-
Cake\Database\Driver$driver - Экземпляр драйвера для преобразования.
Возвращает
string|resourceПереопределяет
Cake\Database\Type::toDatabase() Реализация
Cake\Database\TypeInterface::toDatabase() toPHP()source public
toPHP( null|string|resource $value , Cake\Database\Driver $driver )
Преобразование двоичных данных в дескрипторы ресурсов
Параметры
- null|string|resource
$value - Значение для преобразования.
-
Cake\Database\Driver$driver - Экземпляр драйвера для преобразования.
Возвращает
resource|nullИсключения
Cake\Core\Exception\ExceptionПереопределяет
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
__debugInfo()source public
__debugInfo( )
Возвращает массив, который можно использовать для описания внутреннего состояния этого объекта.
Возвращает
array_basicTypeCast()source protected
_basicTypeCast( mixed $value )
Проверяет, является ли этот тип базовым, и можно ли его преобразовать с помощью обратного вызова. Если это так, возвращает преобразованное значение.
Устарело
3.1 Все типы теперь должны быть отдельным классомПараметры
- mixed
$value - Значение, которое нужно преобразовать в PHP-эквивалент
Возвращает
mixedboolval()source public static
boolval( mixed $value )
Конвертер типа для булевых значений.
Преобразует строки true/false в булевы значения.
Устарело
3.1.8 Этот метод больше не используется.Параметры
- mixed
$value - Значение, которое нужно преобразовать в булевое значение.
Возвращает
booleanbuild()source public static
build( string $name )
Возвращает объект Type, способный преобразовать тип, определенный по имени.
Параметры
- string
$name - идентификатор типа
Возвращает
Cake\Database\TypeИсключения
InvalidArgumentExceptionЕсли идентификатор типа неизвестен
buildAll()source public static
buildAll( )
Возвращает массив со всеми сопоставленными объектами типа, индексированными по имени.
Возвращает
arrayclear()source public static
clear( )
Очищает все созданные экземпляры и сопоставленные классы типов, полезно для тестирования
getBaseType()source public
getBaseType( )
Возвращает базовое имя типа, от которого наследуется этот класс.
Возвращает
stringИмя базового типа, от которого наследуется этот класс.
Реализация
Cake\Database\TypeInterface::getBaseType() getName()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.
Устарело: Использование $type как \Cake\Database\Type[] устарело. Пожалуйста, всегда используйте string[] при передаче массива в качестве первого аргумента.
Параметры
- string|string[]|
Cake\Database\Type[]|null$typeнеобязательный null - Если строка - имя типа для сопоставления, если массив - список массивов для сопоставления
- string|
Cake\Database\Type|null$classNameнеобязательный null - Имя класса или экземпляр объекта.
Возвращает
array|string|nullЕсли $type равен null, то массив с текущими сопоставлениями, если $className равен null, то строка с настроенным именем класса для данного $type, иначе null
newId()source public
newId( )
Генерирует новое значение первичного ключа для заданного типа.
Возвращаемое значение
mixedНовое значение первичного ключа.
Реализация
Cake\Database\TypeInterface::newId() set()source public static
set( string $name , Cake\Database\Type $instance )
Возвращает объект типа, способный преобразовать тип, определенный $name.
Параметры
- строка
$name - Идентификатор типа, который вы хотите установить.
-
Cake\Database\Type$instance - Экземпляр типа, который вы хотите установить.
strval()source public static
strval( mixed $value )
Преобразователь типа для строковых значений.
Преобразует значения в строки
Устарело
3.1.8 Этот метод больше не используется.Параметры
- смешанный
$value - Значение, которое нужно преобразовать в строку.
Возвращаемое значение
строкаПодробное описание свойств
$_namesource
protected строка|null
Идентификатор имени для данного типа.
(Это свойство объявлено здесь снова, чтобы в будущем можно было удалить наследование от Cake\Database\Type.)
© 2005–2018 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.5/class-Cake.Database.Type.BinaryType.html