Класс FormContext
Предоставляет контекстный поставщик для экземпляров {@link \Cake\Form\Form}.
Этот поставщик контекста просто выполняет требования интерфейса, которые имеет FormHelper, и позволяет получить доступ к данным формы.
Константы
-
array<string>VALID_ATTRIBUTES['length', 'precision', 'comment', 'null', 'default']
Краткое описание свойств
- $_form protected
Cake\Form\FormОбъект формы.
- $_validator protected
string|nullИмя валидатора.
Краткое описание методов
-
__construct() public
Конструктор.
-
_schemaDefault() protected
Получить значение по умолчанию из схемы формы для данного поля.
-
attributes() public
Получить ассоциативный массив других атрибутов для имени поля.
-
error() public
Получить ошибки для данного поля
-
fieldNames() public
Получить имена полей объекта верхнего уровня в этом контексте.
-
getMaxLength() public
Получить максимальную длину поля из валидации модели.
-
getPrimaryKey() public
Получить поля, используемые в контексте как первичный ключ.
-
getRequiredMessage() public
Получает сообщение об ошибке «обязательно» по умолчанию для поля
-
hasError() public
Проверить, есть ли у поля прикрепленная к нему ошибка
-
isCreate() public
Возвращает, является ли эта форма операцией создания.
-
isPrimaryKey() public
Возвращает true, если переданное имя поля является частью первичного ключа для этого контекста
-
isRequired() public
Проверить, является ли данное поле «обязательным».
-
primaryKey() public deprecated
Получить поля, используемые в контексте как первичный ключ.
-
type() public
Получить абстрактный тип поля для данного имени поля.
-
val() public
Получить текущее значение для данного поля.
Подробное описание методов
__construct() public
__construct(array $context)
Конструктор.
Параметры
-
array$context Контекстная информация.
_schemaDefault() protected
_schemaDefault(string $field): mixed
Получить значение по умолчанию из схемы формы для данного поля.
Параметры
-
string$field Имя поля.
Возвращает
mixedattributes() public
attributes(string $field): array
Получить ассоциативный массив других атрибутов для имени поля.
Параметры
-
string$field
Возвращает
arrayerror() public
error(string $field): array
Получить ошибки для данного поля
Параметры
-
string$field
Возвращает
arrayfieldNames() public
fieldNames(): array<string>
Получить имена полей объекта верхнего уровня в этом контексте.
Возвращает
array<string>getMaxLength() public
getMaxLength(string $field): int|null
Получить максимальную длину поля из валидации модели.
Параметры
-
string$field
Возвращает
int|nullgetPrimaryKey() public
getPrimaryKey(): array<string>
Получить поля, используемые в контексте как первичный ключ.
Возвращает
array<string>getRequiredMessage() public
getRequiredMessage(string $field): string|null
Получает сообщение об ошибке «обязательно» по умолчанию для поля
Параметры
-
string$field
Возвращает
string|nullhasError() public
hasError(string $field): bool
Проверить, есть ли у поля прикрепленная к нему ошибка
Параметры
-
string$field
Возвращает
boolisCreate() public
isCreate(): bool
Возвращает, является ли эта форма операцией создания.
Возвращает
boolisPrimaryKey() public
isPrimaryKey(string $field): bool
Возвращает true, если переданное имя поля является частью первичного ключа для этого контекста
Параметры
-
string$field
Возвращает
boolisRequired() public
isRequired(string $field): bool|null
Проверить, является ли данное поле «обязательным».
В этом контекстном классе это просто определяется массивом «required».
Параметры
-
string$field
Возвращает
bool|nullprimaryKey() public
primaryKey(): array<string>
Получить поля, используемые в контексте как первичный ключ.
Возвращает
array<string>type() public
type(string $field): string|null
Получить абстрактный тип поля для данного имени поля.
Параметры
-
string$field
Возвращает
string|nullval() public
val(string $field, array<string, mixed> $options = []): mixed
Получить текущее значение для данного поля.
Классы, реализующие этот метод, могут необязательно иметь второй аргумент $options. Допустимые ключи для массива $options:
-
default: Значение по умолчанию для возврата, если значение не найдено в данных или записи контекста.-
schemaDefault: Булево значение, указывающее, следует ли использовать значение по умолчанию из схемы контекста, если оно не указано явно.
-
Параметры
-
string$field -
array<string, mixed>$options optional
Возвращает
mixedПодробное описание свойств
$_form protected
Объект формы.
Тип
Cake\Form\Form$_validator protected
Имя валидатора.
Тип
string|null
© 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.View.Form.FormContext.html
