Класс 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–2018 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.5/class-Cake.Database.TypeMap.html