Spec-Zone.ru › CakePHP 3.6

Класс BinaryType

Конвертер бинарного типа.

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

Cake\Database\Type implements Cake\Database\TypeInterface
Extended by Cake\Database\Type\BinaryType implements 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()

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

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.6/class-Cake.Database.Type.BinaryType.html

Spec-Zone.ru

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