Класс StringType
Конвертер типа String.
Используется для преобразования строковых данных между PHP и типами баз данных.
- Cake\Database\Type implements Cake\Database\TypeInterface
-
Cake\Database\Type\StringType implements Cake\Database\Type\OptionalConvertInterface, Cake\Database\TypeInterface
Прямые подклассы
Наследуемые свойства
Краткое описание методов
- marshal() publicПреобразует данные запроса в PHP строки.
- requiresToPhpCast() public
Возвращает, требуется ли выполнить приведение к типу PHP, так как это не тождественная функция.
- toDatabase() publicПреобразует строковые данные в формат базы данных.
- toPHP() publicПреобразует строковые значения в PHP строки.
- toStatement() publicПолучение правильного типа привязки PDO для строковых данных.
Подробное описание методов
marshal()source public
marshal( mixed $value )
Преобразует данные запроса в PHP строки.
Параметры
- mixed
$value - Значение для преобразования.
Возвращает
string|nullПреобразованное значение.
Переопределяет
Cake\Database\Type::marshal() Реализация
Cake\Database\TypeInterface::marshal() requiresToPhpCast()source public
requiresToPhpCast( )
Возвращает, требуется ли выполнить приведение к типу PHP, так как это не тождественная функция.
Возвращает
booleanFalse, так как результаты из базы данных уже возвращаются в виде строк
Реализация
Cake\Database\Type\OptionalConvertInterface::requiresToPhpCast() toDatabase()source public
toDatabase( mixed $value , Cake\Database\Driver $driver )
Преобразует строковые данные в формат базы данных.
Параметры
- mixed
$value - Значение для преобразования.
-
Cake\Database\Driver$driver - Экземпляр драйвера для преобразования.
Возвращает
string|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 - Экземпляр драйвера для преобразования.
Возвращает
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
$nameoptional null - Имя, идентифицирующее этот тип
__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() со 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.
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
© 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.StringType.html