Spec-Zone.ru › CakePHP 4.2

Класс JsonType

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

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

Пространство имён: Cake\Database\Type

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

  • $_name protected
    string|null

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

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

  • __construct() public

    Конструктор

  • getBaseType() public

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

  • getName() public

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

  • manyToPHP() public

    Возвращает массив значений, преобразованных в представление PHP этого типа.

  • marshal() public

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

  • newId() public

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

  • toDatabase() public

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

  • toPHP() public

    Преобразует заданное значение из типа базы данных в эквивалент PHP.

  • toStatement() public

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

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

__construct() public

__construct(string|null $name = null)

Конструктор

Параметры

string|null $name optional

Имя, идентифицирующее этот тип

getBaseType() public

getBaseType(): string|null

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

Это полезно при расширении базового типа для добавления дополнительной функциональности, но всё ещё необходимо, чтобы остальная часть фреймворка делала те же предположения о базовом типе, от которого он наследуется.

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

string|null

getName() public

getName(): string|null

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

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

string|null

manyToPHP() public

manyToPHP(array $values, string[] $fields, Cake\Database\DriverInterface $driver): array

Возвращает массив значений, преобразованных в представление PHP этого типа.

Параметры

array $values
string[] $fields
Cake\Database\DriverInterface $driver

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

array

marshal() public

marshal(mixed $value): mixed

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

Наиболее полезно для преобразования данных запроса в объекты PHP, которые имеют смысл для остальных слоев ORM/базы данных.

Параметры

mixed $value

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

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

mixed

newId() public

newId(): mixed

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

Этот метод может использоваться типами для создания новых значений первичного ключа при вставке сущностей.

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

mixed

toDatabase() public

toDatabase(mixed $value, Cake\Database\DriverInterface $driver): string|null

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

Параметры

mixed $value

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

Cake\Database\DriverInterface $driver

Экземпляр драйвера для преобразования.

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

string|null

Исключения

InvalidArgumentException

toPHP() public

toPHP(mixed $value, Cake\Database\DriverInterface $driver): string|array|null

Преобразует заданное значение из типа базы данных в эквивалент PHP.

Параметры

mixed $value

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

Cake\Database\DriverInterface $driver

Экземпляр драйвера для преобразования.

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

string|array|null

toStatement() public

toStatement(mixed $value, Cake\Database\DriverInterface $driver): int

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

Параметры

mixed $value

Связываемое значение.

Cake\Database\DriverInterface $driver

Драйвер.

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

int

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

$_name protected

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

Тип

string|null

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

Spec-Zone.ru

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