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