Класс TypeMap
Реализует стандартные и одноразовые сопоставления столбцов с их соответствующими типами
Подробное описание метода
__constructsource public
__construct( array $defaults [] )
Создаёт экземпляр с заданными значениями по умолчанию
Параметры
- массив
$defaultsнеобязательно [] - Значения по умолчанию.
addDefaultssource public
addDefaults( array $types )
Добавляет дополнительные типы по умолчанию в карту типов.
Если ключ уже существует, он не будет перезаписан.
Параметры
- массив
$types - Дополнительные типы для добавления.
defaultssource public
defaults( array $defaults null )
Настраивает карту полей по умолчанию и их соответствующих типов, которые будут использоваться в качестве списка типов по умолчанию для каждой функции в этом классе с параметром $types. Полезно для избежания повторений при вызове одних и тех же функций с одними и теми же полями и типами.
Если вызывается без аргументов, она вернёт текущие настроенные типы.
Пример
$query->defaults(['created' => 'datetime', 'is_visible' => 'boolean']);
Этот метод заменит все существующие карты типов предоставленными.
Параметры
- массив
$defaultsнеобязательно null - ассоциативный массив, где ключи — имена полей, а значения — соответствующие типы.
Возвращает
mixed$this|массив
typesource public
type( string $column )
Возвращает тип заданного столбца. Если настроен тип для одноразового использования, тип столбца будет искаться в стандартном сопоставлении. Если ни тот, ни другой не существует, будет возвращён null.
Параметры
- строка
$column - Тип заданного столбца
Возвращает
null|stringnull|строка
typessource public
types( array $types null )
Устанавливает карту полей и их соответствующих типов для одноразового использования.
Если вызывается без аргументов, она вернёт текущие настроенные типы.
Пример
$query->types(['created' => 'time']);
Этот метод заменит все существующие карты типов предоставленными.
Параметры
- массив
$typesнеобязательно null - ассоциативный массив, где ключи — имена полей, а значения — соответствующие типы.
Возвращает
mixed$this|массив
Резюме свойств
© 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.TypeMap.html