Класс 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
_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, способный преобразовать тип, идентифицированный по $name.
Параметры
- 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|array|Cake\Database\Type|null $type null , string|null $className null )
Регистрирует новый идентификатор типа и сопоставляет его с полным именем класса с пространством имён. Если вызвана без аргументов, она вернёт текущий массив сопоставлений типов. Если $className опущено, она вернёт сопоставленный класс для $type.
Параметры
- string|array|
Cake\Database\Type|null$typeнеобязательно null - если строка имя типа для сопоставления, если массив список массивов для сопоставления
- string|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–2017 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.4/class-Cake.Database.Type.BinaryType.html