Spec-Zone.ru › CakePHP 3.3

Класс TypeMap

Реализует стандартные и одноразовые сопоставления столбцов со связанными типами

Пространство имён: Cake\Database
Расположение: Database/TypeMap.php

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

  • $_defaults protected
    array
    Ассоциативный массив со стандартными полями и связанными типами, которые этот запрос может содержать.
  • $_types protected
    array
    Ассоциативный массив с полями и связанными типами, которые переопределяют стандартные значения, которые этот запрос может содержать

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

  • __construct() public
    Создаёт экземпляр с заданными значениями по умолчанию
  • addDefaults() public
    Добавляет дополнительные типы по умолчанию в карту типов.
  • defaults() public

    Настраивает карту стандартных полей и связанных с ними типов, которые будут использоваться в качестве списка стандартных типов для каждой функции в этом классе с параметром $types. Полезно для избежания повторений при вызове одних и тех же функций с одними и теми же полями и типами.

  • toArray() public
    Возвращает массив всех сопоставленных типов
  • type() public

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

  • types() public
    Устанавливает карту полей и связанных с ними типов для одноразового использования.

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

__construct()source public

__construct( array $defaults [] )

Создаёт экземпляр с заданными значениями по умолчанию

Параметры

array $defaults необязательно []
Значения по умолчанию для использования.

addDefaults()source public

addDefaults( array $types )

Добавляет дополнительные типы по умолчанию в карту типов.

Если ключ уже существует, он не будет перезаписан.

Параметры

array $types
Дополнительные типы для добавления.

defaults()source public

defaults( array $defaults null )

Настраивает карту стандартных полей и связанных с ними типов, которые будут использоваться в качестве списка стандартных типов для каждой функции в этом классе с параметром $types. Полезно для избежания повторений при вызове одних и тех же функций с одними и теми же полями и типами.

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

Пример

$query->defaults(['created' => 'datetime', 'is_visible' => 'boolean']);

Этот метод заменит все существующие карты типов предоставленными.

Параметры

array $defaults необязательно null

ассоциативный массив, где ключи — имена полей, а значения — соответствующий тип.

Возвращает


$this|array

toArray()source public

toArray( )

Возвращает массив всех сопоставленных типов

Возвращает

array

type()source public

type( string $column )

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

Параметры

string $column
Тип для заданного столбца

Возвращает

null|string

types()source public

types( array $types null )

Устанавливает карту полей и связанных с ними типов для одноразового использования.

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

Пример

$query->types(['created' => 'time']);

Этот метод заменит все существующие карты типов предоставленными.

Параметры

array $types необязательно null

ассоциативный массив, где ключи — имена полей, а значения — соответствующий тип.

Возвращает


$this|array

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

$_defaultssource

protected array

Ассоциативный массив со стандартными полями и связанными типами, которые этот запрос может содержать.

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

$_typessource

protected array

Ассоциативный массив с полями и связанными типами, которые переопределяют стандартные значения, которые этот запрос может содержать

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

[]

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

Spec-Zone.ru

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