Класс TypeMap
Реализует стандартные и одноразовые сопоставления столбцов с их соответствующими типами
Краткое описание свойств
-
$_defaultsprotectedАссоциативный массив со стандартными полями и связанными типами, которые может содержать этот запрос.array -
$_typesprotectedАссоциативный массив с полями и связанными типами, которые переопределяют стандартные, которые может содержать этот запрос.array
Краткое описание методов
- __construct() publicСоздаёт экземпляр с заданными стандартными значениями.
- addDefaults() publicДобавляет дополнительные стандартные типы в карту типов.
- defaults() public
Настраивает карту стандартных полей и их соответствующих типов, которые будут использоваться в качестве стандартного списка типов для каждой функции в этом классе с параметром $types. Полезно для избежания повторений при вызове одних и тех же функций с одними и теми же полями и типами.
- getDefaults() publicВозвращает текущие настроенные типы.
- getTypes() publicПолучает карту полей и их соответствующих типов для одноразового использования.
- setDefaults() public
Настраивает карту стандартных полей и их соответствующих типов, которые будут использоваться в качестве стандартного списка типов для каждой функции в этом классе с параметром $types. Полезно для избежания повторений при вызове одних и тех же функций с одними и теми же полями и типами.
- setTypes() publicУстанавливает карту полей и их соответствующих типов для одноразового использования.
- toArray() publicВозвращает массив всех сопоставленных типов.
- type() public
Возвращает тип данного столбца. Если не настроен тип для одноразового использования, тип столбца будет искать в стандартном сопоставлении. Если ни то, ни другое не найдено, будет возвращён null.
- types() publicУстанавливает карту полей и их соответствующих типов для одноразового использования.
Подробное описание методов
__construct()source public
__construct( array $defaults [] )
Создаёт экземпляр с заданными стандартными значениями
Параметры
- массив
$defaultsнеобязательно [] - Стандартные значения для использования.
addDefaults()source public
addDefaults( array $types )
Добавляет дополнительные стандартные типы в карту типов.
Если ключ уже существует, он не будет перезаписан.
Параметры
- массив
$types - Дополнительные типы для добавления.
defaults()source public
defaults( array $defaults null )
Настраивает карту стандартных полей и их соответствующих типов, которые будут использоваться в качестве стандартного списка типов для каждой функции в этом классе с параметром $types. Полезно для избежания повторений при вызове одних и тех же функций с одними и теми же полями и типами.
Если вызывается без аргументов, она вернёт текущие настроенные типы.
Пример
$query->defaults(['created' => 'datetime', 'is_visible' => 'boolean']);
Этот метод заменит все существующие карты типов предоставленными.
Устаревшее
3.4.0 Используйте setDefaults()/getDefaults() вместо этого.Параметры
- массив
$defaultsнеобязательно null ассоциативный массив, где ключи — имена полей, а значения — соответствующие типы.
Возвращает
$this|массив
getTypes()source public
getTypes( )
Получает карту полей и их соответствующих типов для одноразового использования.
Возвращает
массивsetDefaults()source public
setDefaults( array $defaults )
Настраивает карту стандартных полей и их соответствующих типов, которые будут использоваться в качестве стандартного списка типов для каждой функции в этом классе с параметром $types. Полезно для избежания повторений при вызове одних и тех же функций с одними и теми же полями и типами.
Пример
$query->setDefaults(['created' => 'datetime', 'is_visible' => 'boolean']);
Этот метод заменит все существующие карты типов предоставленными.
Параметры
- массив
$defaults Ассоциативный массив, где ключи — имена полей, а значения — соответствующие типы.
Возвращает
$this
setTypes()source public
setTypes( array $types )
Устанавливает карту полей и их соответствующих типов для одноразового использования.
Пример
$query->setTypes(['created' => 'time']);
Этот метод заменит все существующие карты типов предоставленными.
Параметры
- массив
$types Ассоциативный массив, где ключи — имена полей, а значения — соответствующие типы.
Возвращает
$this
type()source public
type( string $column )
Возвращает тип данного столбца. Если не настроен тип для одноразового использования, тип столбца будет искать в стандартном сопоставлении. Если ни то, ни другое не найдено, будет возвращён null.
Параметры
- строка
$column - Тип для заданного столбца
Возвращает
null|строкаtypes()source public
types( array $types null )
Устанавливает карту полей и их соответствующих типов для одноразового использования.
Если вызывается без аргументов, она вернёт текущие настроенные типы.
Пример
$query->types(['created' => 'time']);
Этот метод заменит все существующие карты типов предоставленными.
Устаревшее
3.4.0 Используйте setTypes()/getTypes() вместо этого.Параметры
- массив
$typesнеобязательно null ассоциативный массив, где ключи — имена полей, а значения — соответствующие типы.
Возвращает
$this|массив
Подробное описание свойств
$_defaultssource
protected массив
Ассоциативный массив со стандартными полями и связанными типами, которые может содержать этот запрос.
Используется для избежания повторений при вызове нескольких функций внутри этого класса, которые могут потребовать настраиваемого типа для определённого поля.
$_typessource
protected массив
Ассоциативный массив с полями и связанными типами, которые переопределяют стандартные, которые может содержать этот запрос
Используется для избежания повторений при вызове нескольких функций внутри этого класса, которые могут потребовать настраиваемого типа для определённого поля.
[]
© 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.4/class-Cake.Database.TypeMap.html