Класс BoolType
Конвертер типа Bool.
Используется для преобразования данных bool между PHP и типами баз данных.
- Cake\Database\Type реализует Cake\Database\TypeInterface
-
Cake\Database\Type\BoolType реализует Cake\Database\TypeInterface, Cake\Database\Type\BatchCastingInterface
Краткое описание свойств
-
$_nameprotectedИмя идентификатора для данного типа.string|null
Унаследованные свойства
Краткое описание методов
- __construct() publicКонструктор.
- manyToPHP() public
Возвращает массив значений, преобразованных в представление этого типа в PHP.
- marshal() publicПреобразует данные запроса в булевы значения PHP.
- toDatabase() publicПреобразование данных bool в формат базы данных.
- toPHP() publicПреобразование булевых значений в PHP булевы значения
- toStatement() publicПолучение правильного типа привязки PDO для данных bool.
Подробное описание методов
__construct()source public
__construct( string|null $name = null )
Конструктор.
(Этот метод объявлен здесь снова, чтобы в будущем можно было удалить наследование от Cake\Database\Type.)
Параметры
- string|null
$nameoptional null - Имя, идентифицирующее этот тип
Переопределяет
Cake\Database\Type::__construct() manyToPHP()source public
manyToPHP( array $values , array $fields , Cake\Database\Driver $driver )
Возвращает массив значений, преобразованных в представление этого типа в PHP.
Параметры
- array
$values - Исходный массив значений, содержащий поля, которые нужно преобразовать
- array
$fields - Ключи полей для преобразования
-
Cake\Database\Driver$driver - Объект, из которого будут извлечены предпочтения и конфигурация базы данных.
Возвращает
arrayРеализация
Cake\Database\Type\BatchCastingInterface::manyToPHP() marshal()source public
marshal( mixed $value )
Преобразует данные запроса в булевы значения PHP.
Параметры
- mixed
$value - Значение для преобразования.
Возвращает
boolean|nullПреобразованное значение.
Переопределяет
Cake\Database\Type::marshal() Реализация
Cake\Database\TypeInterface::marshal() toDatabase()source public
toDatabase( mixed $value , Cake\Database\Driver $driver )
Преобразование данных bool в формат базы данных.
Параметры
- mixed
$value - Значение для преобразования.
-
Cake\Database\Driver$driver - Экземпляр драйвера для преобразования.
Возвращает
boolean|nullПереопределяет
Cake\Database\Type::toDatabase() Реализация
Cake\Database\TypeInterface::toDatabase() toPHP()source public
toPHP( mixed $value , Cake\Database\Driver $driver )
Преобразование булевых значений в PHP булевы значения
Параметры
- mixed
$value - Значение для преобразования.
-
Cake\Database\Driver$driver - Экземпляр драйвера для преобразования.
Возвращает
boolean|nullПереопределяет
Cake\Database\Type::toPHP() Реализация
Cake\Database\TypeInterface::toPHP() toStatement()source public
toStatement( mixed $value , Cake\Database\Driver $driver )
Получение правильного типа привязки PDO для данных bool.
Параметры
- 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 deprecated
_basicTypeCast( mixed $value )
Проверяет, является ли данный тип базовый и может ли он быть преобразован с помощью обратного вызова. Если это так, возвращает преобразованное значение
Устарело
3.1 Все типы теперь должны быть отдельными классамиПараметры
- mixed
$value - Значение, которое нужно преобразовать в PHP эквивалент
Возвращает
mixedboolval()source public static deprecated
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() getMap()source public static
getMap( string|null $type = null )
Получить сопоставленное имя класса или экземпляр для типа(ов).
Параметры
- string|null
$typeoptional 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() со строковым массивом вместо этого. - Передача $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
newId()source public
newId( )
Генерирует новое значение первичного ключа для заданного типа.
Возвращает
mixedНовое значение первичного ключа.
Реализация
Cake\Database\TypeInterface::newId() 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.BoolType.html