Spec-Zone.ru › CakePHP 3.8

Класс BinaryType

Конвертер двоичных типов.

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

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

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

  • $_name protected
    string|null
    Имя идентификатора для данного типа.

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

  • _basicTypes, _builtTypes, _types

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

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

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

__construct()source public

__construct( string|null $name = null )

Конструктор.

(Этот метод объявлен здесь повторно, чтобы в будущем можно было удалить наследование от Cake\Database\Type.)

Параметры

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

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

Cake\Database\Type::__construct()

marshal()source public

marshal( mixed $value )

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

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

Параметры

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

Возвращает

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

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

Cake\Database\Type::marshal()

Реализация

Cake\Database\TypeInterface::marshal()

toDatabase()source public

toDatabase( string|resource $value , Cake\Database\Driver $driver )

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

Двоичные данные не изменяются перед вставкой в базу данных. PDO будет обрабатывать чтение дескрипторов файлов.

Параметры

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

Возвращает

string|resource

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

Cake\Database\Type::toDatabase()

Реализация

Cake\Database\TypeInterface::toDatabase()

toPHP()source public

toPHP( null|string|resource $value , Cake\Database\Driver $driver )

Преобразование двоичных данных в дескрипторы ресурсов

Параметры

null|string|resource $value
Значение для преобразования.
Cake\Database\Driver $driver
Экземпляр драйвера для преобразования.

Возвращает

resource|null

Исключения

Cake\Core\Exception\Exception

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

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

__debugInfo()source public

__debugInfo( )

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

Возвращает

array

_basicTypeCast()source protected deprecated

_basicTypeCast( mixed $value )

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

Устарело

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

Параметры

mixed $value
Значение, подлежащее преобразованию в PHP-эквивалент

Возвращает

mixed

boolval()source public static deprecated

boolval( mixed $value )

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

Преобразует строковые true/false в логические значения.

Устарело

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

Параметры

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

Возвращает

boolean

build()source public static

build( string $name )

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

Параметры

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

getMap()source public static

getMap( string|null $type = null )

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

Параметры

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

Возвращает

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

С

3.6.2

getName()source public

getName( )

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

Возвращает

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

Реализация

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

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

$_namesource

protected string|null

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

(Это свойство объявлено здесь снова, чтобы в будущем можно было удалить наследование от Cake\Database\Type.)

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

Spec-Zone.ru

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