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