Spec-Zone.ru › CakePHP 3.8

Класс StringType

Конвертер типа строки.

Используется для преобразования строковых данных между PHP и типами баз данных.

Cake\Database\Type implements Cake\Database\TypeInterface
Расширенный Cake\Database\Type\StringType implements Cake\Database\Type\OptionalConvertInterface, Cake\Database\TypeInterface

Непосредственные подклассы

  • Cake\Database\Type\UuidType
Пространство имён: Cake\Database\Type
Расположение: Database/Type/StringType.php

Унаследованные свойства

  • _basicTypes, _builtTypes, _name, _types

Краткое описание методов

  • marshal() public
    Преобразует данные запроса в PHP-строки.
  • requiresToPhpCast() public

    Возвращает, требуется ли выполнить преобразование в PHP, так как это не тождественная функция.

  • toDatabase() public
    Преобразует строковые данные в формат базы данных.
  • toPHP() public
    Преобразует строковые значения в PHP-строки.
  • toStatement() public
    Получает правильный тип привязки PDO для строковых данных.

Подробное описание методов

marshal()source public

marshal( mixed $value )

Преобразует данные запроса в PHP-строки.

Параметры

смешанный $value
Значение для преобразования.

Возвращаемое значение

строка|null
Преобразованное значение.

Переопределяет

Cake\Database\Type::marshal()

Реализация

Cake\Database\TypeInterface::marshal()

requiresToPhpCast()source public

requiresToPhpCast( )

Возвращает, требуется ли выполнить преобразование в PHP, так как это не тождественная функция.

Возвращаемое значение

boolean
False, так как результаты базы данных уже возвращаются как строки

Реализация

Cake\Database\Type\OptionalConvertInterface::requiresToPhpCast()

toDatabase()source public

toDatabase( mixed $value , Cake\Database\Driver $driver )

Преобразует строковые данные в формат базы данных.

Параметры

смешанный $value
Значение для преобразования.
Cake\Database\Driver $driver
Экземпляр драйвера для преобразования.

Возвращаемое значение

строка|null

Переопределяет

Cake\Database\Type::toDatabase()

Реализация

Cake\Database\TypeInterface::toDatabase()

toPHP()source public

toPHP( mixed $value , Cake\Database\Driver $driver )

Преобразует строковые значения в PHP-строки.

Параметры

смешанный $value
Значение для преобразования.
Cake\Database\Driver $driver
Экземпляр драйвера для преобразования.

Возвращаемое значение

строка|null

Переопределяет

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

__construct()source public

__construct( string|null $name = null )

Конструктор

Параметры

строка|null $name необязательно null
Имя, идентифицирующее этот тип

__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
Значение, которое нужно преобразовать в логическое.

Возвращаемое значение

boolean

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( )

Возвращает имя базового типа, от которого наследуется этот класс.

Возвращаемое значение

строка
Имя базового типа, от которого наследуется этот класс.

Реализация

Cake\Database\TypeInterface::getBaseType()

getMap()source public static

getMap( string|null $type = null )

Получает сопоставленное имя класса или экземпляр для типа(ов).

Параметры

строка|null $type необязательно null
Имя типа для получения сопоставленного класса или null для получения массива сопоставлений.

Возвращаемое значение

массив|строка|Cake\Database\TypeInterface|null
Настроенное имя класса или экземпляр для данного $type или массив сопоставлений.

С версии

3.6.2

getName()source public

getName( )

Возвращает имя идентификатора типа для этого объекта.

Возвращаемое значение

строка
Имя идентификатора типа для этого объекта.

Реализация

Cake\Database\TypeInterface::getName()
END_OF_DOCUMENT_MARKER

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 instance устарело, используйте только строку имени класса. - Использование этого метода в качестве геттера устарело. Используйте 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.2

strval()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.8/class-Cake.Database.Type.StringType.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API