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