Spec-Zone.ru › CakePHP 3.8

Класс TypeMap

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

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

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

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

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

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

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

  • getDefaults() public
    Возвращает текущие настроенные типы.
  • getTypes() public
    Получает карту полей и соответствующих типов для однократного использования.
  • setDefaults() public
    Настраивает карту полей и соответствующего типа.
  • setTypes() public
    Устанавливает карту полей и соответствующих типов для однократного использования.
  • toArray() public
    Возвращает массив всех сопоставленных типов.
  • type() public

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

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

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

__construct()source public

__construct( array $defaults = [] )

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

Параметры

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

addDefaults()source public

addDefaults( array $types )

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

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

Параметры

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

defaults()source public deprecated

defaults( array $defaults = null )

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

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

Пример

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

Этот метод заменит все существующие стандартные сопоставления предоставленными. Для добавления в сопоставления используйте addDefaults()

Deprecated

3.4.0 Используйте setDefaults()/getDefaults() вместо этого.

Параметры

массив $defaults необязательно null

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

Возвращает


$this|массив

getDefaults()source public

getDefaults( )

Возвращает текущие настроенные типы.

Возвращает

массив

getTypes()source public

getTypes( )

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

Возвращает

массив

setDefaults()source public

setDefaults( array $defaults )

Настраивает карту полей и соответствующего типа.

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

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

Пример

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

Этот метод заменит все существующие стандартные сопоставления предоставленными. Для добавления в сопоставления используйте addDefaults().

Параметры

массив $defaults

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

Возвращает


$this

setTypes()source public

setTypes( array $types )

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

Пример

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

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

Параметры

массив $types

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

Возвращает


$this

toArray()source public

toArray( )

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

Возвращает

массив

type()source public

type( string $column )

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

Параметры

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

Возвращает

null|строка

types()source public deprecated

types( array $types = null )

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

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

Пример

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

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

Deprecated

3.4.0 Используйте setTypes()/getTypes() вместо этого.

Параметры

массив $types необязательно null

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

Возвращает


$this|массив

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

$_defaultssource

protected массив

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

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

$_typessource

protected массив

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

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

[]

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

Spec-Zone.ru

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