Spec-Zone.ru › CakePHP 3.3

Класс JsonType

Конвертер типов JSON.

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

Cake\Database\Type реализует Cake\Database\TypeInterface
Расширенный Cake\Database\Type\JsonType реализует Cake\Database\TypeInterface
Пространство имён: Cake\Database\Type
Расположение: Database/Type/JsonType.php

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

  • _basicTypes, _builtTypes, _name, _types

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

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

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

marshal()source public

marshal( mixed $value )

Преобразует данные запроса в структуру, совместимую с JSON.

Параметры

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

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

mixed
Преобразованное значение.

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

Cake\Database\Type::marshal()

Реализация

Cake\Database\TypeInterface::marshal()

toDatabase()source public

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

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

Параметры

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|array

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

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

set()source public static

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

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

Параметры

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

strval()source public static

strval( mixed $value )

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

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

Устарело

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

Параметры

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

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

boolean

© 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.3/class-Cake.Database.Type.JsonType.html

Spec-Zone.ru

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