Spec-Zone.ru › CakePHP 3.4

Класс StringType

Конвертер типа String.

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

Cake\Database\Type реализует Cake\Database\TypeInterface
Extended by Cake\Database\Type\StringType реализует 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.

Параметры

mixed $value
Значение для преобразования.

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

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

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

Параметры

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 $name optional null
Имя, идентифицирующее этот тип

_basicTypeCast()source protected

_basicTypeCast( mixed $value )

Проверяет, является ли этот тип базовым и может ли он быть преобразован с помощью обратного вызова Если это так, возвращает преобразованное значение

Устарело

3.1 Все типы теперь должны быть отдельным классом

Параметры

mixed $value
значение для преобразования в PHP-эквивалент

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

mixed

boolval()source public static

boolval( mixed $value )

Конвертер типа для булевых значений.

Преобразует строковые true/false в булевы.

Устарело

3.1.8 Этот метод больше не используется.

Параметры

mixed $value
Значение для преобразования в булево значение.

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

boolean

build()source public static

build( string $name )

Возвращает объект Type, способный преобразовывать тип, идентифицированный $name

Параметры

string $name
идентификатор типа

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

Cake\Database\Type

Исключения

InvalidArgumentException
Если идентификатор типа неизвестен

buildAll()source public static

buildAll( )

Возвращает массив со всеми сопоставленными объектами типа, индексированными по имени

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

array

clear()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 optional null
если строковое имя типа для сопоставления, если массив списков массивов для сопоставления
string|null $className optional null
Имя класса для регистрации.

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

array|string|null

если $type равен null, то массив с текущим сопоставлением, если $className равен null, строка с конфигурированным именем класса для заданного $type, в противном случае null


newId()source public

newId( )

Генерирует новое значение первичного ключа для данного типа.

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

mixed
Новое значение первичного ключа.

Реализация

Cake\Database\TypeInterface::newId()
END_OF_DOCUMENT_MARKER

set()source public static

set( string $name , Cake\Database\Type $instance )

Возвращает объект Type, способный преобразовать тип, идентифицированный $name

Параметры

строка $name
Идентификатор типа, который вы хотите установить.
Cake\Database\Type $instance
Экземпляр типа, который вы хотите установить.

strval()source public static

strval( mixed $value )

Преобразователь типа для строковых значений.

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

Устаревший

3.1.8 Этот метод больше не используется.

Параметры

смешанное $value
Значение, которое нужно преобразовать в строку.

Возвращает

строка

© 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.StringType.html

Spec-Zone.ru

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