Интерфейс ContextInterface
Интерфейс для реализаций контекста FormHelper.
Прямые реализаторы
- Cake\View\Form\ArrayContext
- Cake\View\Form\EntityContext
- Cake\View\Form\FormContext
- Cake\View\Form\NullContext
Краткое описание методов
- attributes() publicПолучить ассоциативный массив дополнительных атрибутов для имени поля.
- error() publicПолучить ошибки для заданного поля
- fieldNames() publicПолучить имена полей верхнего уровня в этом контексте.
- hasError() publicПроверить, есть ли ошибка, связанная с полем
- isCreate() publicВозвращает, является ли эта форма для операции создания.
- isPrimaryKey() publicВозвращает true, если переданное имя поля является частью первичного ключа для этого контекста
- isRequired() publicПроверить, является ли заданное поле 'обязательным'.
В этом классе контекста это просто определяется массивом 'required'.
- primaryKey() publicПолучить поля, используемые в контексте как первичный ключ.
- type() publicПолучить абстрактный тип поля для заданного имени поля.
- val() publicПолучить текущее значение для заданного поля.
Подробное описание методов
attributes()source public
attributes( string $field )
Получить ассоциативный массив дополнительных атрибутов для имени поля.
Параметры
- string
$field - Путь с точками, чтобы получить дополнительные данные.
Возвращает
массивМассив данных, описывающих дополнительные атрибуты поля.
error()source public
error( string $field )
Получить ошибки для заданного поля
Параметры
- string
$field - Путь с точками для проверки ошибок.
Возвращает
массивМассив ошибок, пустой массив будет возвращён, когда в контексте нет ошибок.
fieldNames()source public
fieldNames( )
Получить имена полей верхнего уровня в этом контексте.
Возвращает
массивСписок имён полей в контексте.
hasError()source public
hasError( string $field )
Проверить, есть ли ошибка, связанная с полем
Параметры
- string
$field - Путь с точками для проверки ошибок.
Возвращает
booleanВозвращает true, если ошибки для поля не пустые.
isCreate()source public
isCreate( )
Возвращает, является ли эта форма для операции создания.
Возвращает
booleanisPrimaryKey()source public
isPrimaryKey( string $field )
Возвращает true, если переданное имя поля является частью первичного ключа для этого контекста
Параметры
- string
$field Путь с точками для поля, для которого нужно значение.
Возвращает
booleanisRequired()source public
isRequired( string $field )
Проверить, является ли заданное поле 'обязательным'.
В этом классе контекста это просто определяется массивом 'required'.
Параметры
- string
$field - Путь с точками для проверки обязательности.
Возвращает
booleanprimaryKey()source public
primaryKey( )
Получить поля, используемые в контексте как первичный ключ.
Возвращает
массивtype()source public
type( string $field )
Получить абстрактный тип поля для заданного имени поля.
Параметры
- string
$field - Путь с точками для получения типа схемы.
Возвращает
null|строкаАбстрактный тип данных или null.
См.
Cake\Database\Typeval()source public
val( string $field )
Получить текущее значение для заданного поля.
Классы, реализующие этот метод, могут по желанию иметь второй аргумент $options. Действительными ключами для массива $options являются:
-
default: Значение по умолчанию, которое возвращается, если значение не найдено в данных запроса или записи контекста. -
schemaDefault: Булево значение, указывающее, следует ли использовать значение по умолчанию из схемы контекста, если оно явно не указано.
Параметры
- string
$field Путь с точками для поля, для которого нужно значение.
Возвращает
mixed
© 2005–2017 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.4/class-Cake.View.Form.ContextInterface.html