Spec-Zone.ru › CakePHP 3.1

Класс Type

Оборачивает все функции преобразования значений из базы данных в PHP и из PHP в базу данных.

Прямые известные подклассы

Cake\Database\Type\BinaryType, Cake\Database\Type\BoolType, Cake\Database\Type\DateTimeType, Cake\Database\Type\FloatType, Cake\Database\Type\IntegerType, Cake\Database\Type\StringType

Косвенные известные подклассы

Cake\Database\Type\DateType, Cake\Database\Type\TimeType, Cake\Database\Type\UuidType
Пространство имён: Cake\Database
Расположение: Database/Type.php

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

__constructsource public

__construct( string $name null )

Конструктор

Параметры

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

_basicTypeCastsource protected

_basicTypeCast( mixed $value )

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

Устарело

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

Параметры

mixed $value
значение, которое нужно преобразовать в эквивалент PHP

Возвращает

mixed
mixed

boolvalsource public static

boolval( mixed $value )

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

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

Устарело

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

Параметры

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

Возвращает

boolean
bool

buildsource public static

build( string $name )

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

Параметры

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

Возвращает

Cake\Database\Type
Type

Исключения

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

clearsource public static

clear( )

Очищает все созданные экземпляры и сопоставленные классы типов, полезно для тестирования

getBaseTypesource public

getBaseType( )

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

Возвращает

string
string

getNamesource public

getName( )

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

Возвращает

string
string

mapsource public static

map( string|array|Cake\Database\Type|null $type null , string|null $className null )

Регистрирует новый идентификатор типа и сопоставляет его с полным именем класса с пространством имён. Если вызвать без аргументов, он вернёт текущий массив карт типов. Если $className опущен, он вернёт сопоставленный класс для $type.

Параметры

string|array|Cake\Database\Type|null $type необязательный null
если строка - имя типа для сопоставления, если массив - список массивов для сопоставления
string|null $className необязательный null
Имя класса для регистрации.

Возвращает

array|string|null
если $type равен null, то массив с текущей картой, если $className равен null, то строка с именем настроенного класса для данного $type, в противном случае null

marshalsource public

marshal( mixed $value )

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

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

Параметры

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

Возвращает

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

newIdsource public

newId( )

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

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

Возвращает

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

См. также

Cake\Database\Type\UuidType

setsource public static

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

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

Параметры

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

strvalsource public static

strval( mixed $value )

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

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

Устарело

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

Параметры

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

Возвращает

boolean
bool

toDatabasesource public

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

Преобразует заданное значение из типа PHP в тип, допустимый для базы данных

Параметры

mixed $value
значение, которое нужно преобразовать в эквивалент базы данных
Cake\Database\Driver $driver
объект, из которого будут извлечены настройки и конфигурация базы данных

Возвращает

mixed
mixed

toPHPsource public

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

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

Параметры

mixed $value
значение, которое нужно преобразовать в эквивалент PHP
Cake\Database\Driver $driver
объект, из которого будут извлечены настройки и конфигурация базы данных

Возвращает

mixed
mixed

toStatementsource public

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

Преобразует заданное значение в эквивалент Statement

Параметры

mixed $value
значение, которое нужно преобразовать в эквивалент PHP
Cake\Database\Driver $driver
объект, из которого будут извлечены настройки и конфигурация базы данных

Возвращает

mixed
mixed

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

$_basicTypessource

protected static массив

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

Устаревший

3.1 Все типы теперь будут использовать определенный класс
[
    'string' => ['callback' => ['\Cake\Database\Type', 'strval']],
    'text' => ['callback' => ['\Cake\Database\Type', 'strval']],
    'boolean' => [
        'callback' => ['\Cake\Database\Type', 'boolval'],
        'pdo' => PDO::PARAM_BOOL
    ],
]

$_builtTypessource

protected static массив

Содержит отображение экземпляров объектов типов для повторного использования при необходимости.

[]

$_namesource

protected строка

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

null

$_typessource

protected static массив

Список поддерживаемых типов баз данных. В качестве ключа используется удобочитаемый идентификатор, а в качестве значения — полное имя пространства имён класса, представляющее класс, который будет выполнять фактические преобразования типов.

[
    'biginteger' => 'Cake\Database\Type\IntegerType',
    'binary' => 'Cake\Database\Type\BinaryType',
    'boolean' => 'Cake\Database\Type\BoolType',
    'date' => 'Cake\Database\Type\DateType',
    'datetime' => 'Cake\Database\Type\DateTimeType',
    'decimal' => 'Cake\Database\Type\FloatType',
    'float' => 'Cake\Database\Type\FloatType',
    'integer' => 'Cake\Database\Type\IntegerType',
    'string' => 'Cake\Database\Type\StringType',
    'text' => 'Cake\Database\Type\StringType',
    'time' => 'Cake\Database\Type\TimeType',
    'timestamp' => 'Cake\Database\Type\DateTimeType',
    'uuid' => 'Cake\Database\Type\UuidType',
]

© 2005–2016 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.
http://api.cakephp.org/3.1/class-Cake.Database.Type.html

Spec-Zone.ru

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