Класс FormContext
Предоставляет поставщик контекста для экземпляров Cake\Form\Form.
Этот поставщик контекста просто выполняет требования интерфейса FormHelper и позволяет получить доступ к данным запроса.
- Cake\View\Form\FormContext реализует Cake\View\Form\ContextInterface
Краткое описание свойств
Краткое описание методов
- __construct() publicКонструктор.
- attributes() publicПолучить ассоциативный массив дополнительных атрибутов для имени поля.
- error() publicПолучить ошибки для заданного поля
- fieldNames() publicПолучить имена полей верхнего уровня в этом контексте.
- hasError() publicПроверить, есть ли у поля ошибка.
- isCreate() publicВозвращает, предназначена ли эта форма для операции создания.
- isPrimaryKey() publicВозвращает true, если переданное имя поля является частью первичного ключа для этого контекста
- isRequired() publicПроверить, является ли заданное поле обязательным.
- primaryKey() publicПолучить поля, используемые в контексте, как первичный ключ.
- type() publicПолучить абстрактный тип поля для заданного имени поля.
- val() publicПолучить текущее значение для заданного поля.
Подробное описание методов
__construct()source public
__construct( Cake\Http\ServerRequest $request , array $context )
Конструктор.
Параметры
-
Cake\Http\ServerRequest$request - Объект запроса.
- массив
$context - Информация о контексте.
attributes()source public
attributes( string $field )
Получить ассоциативный массив дополнительных атрибутов для имени поля.
Параметры
- строка
$field - Путь с разделителями «точка» для получения дополнительных данных.
Возвращает
массивМассив данных, описывающих дополнительные атрибуты поля.
Реализация
Cake\View\Form\ContextInterface::attributes() error()source public
error( string $field )
Получить ошибки для заданного поля
Параметры
- строка
$field - Путь с разделителями «точка» для проверки ошибок.
Возвращает
массивМассив ошибок, пустой массив будет возвращён, когда контекст не содержит ошибок.
Реализация
Cake\View\Form\ContextInterface::error() fieldNames()source public
fieldNames( )
Получить имена полей верхнего уровня в этом контексте.
Возвращает
массивСписок имён полей в контексте.
Реализация
Cake\View\Form\ContextInterface::fieldNames() hasError()source public
hasError( string $field )
Проверить, есть ли у поля ошибка
Параметры
- строка
$field - Путь с разделителями «точка» для проверки ошибок.
Возвращает
логическоеВозвращает true, если массив ошибок для поля не пустой.
Реализация
Cake\View\Form\ContextInterface::hasError() isCreate()source public
isCreate( )
Возвращает, предназначена ли эта форма для операции создания.
Возвращает
логическоеРеализация
Cake\View\Form\ContextInterface::isCreate() isPrimaryKey()source public
isPrimaryKey( string $field )
Возвращает true, если переданное имя поля является частью первичного ключа для этого контекста
Параметры
- строка
$field Путь с разделителями «точка» до поля, для которого требуется значение.
Возвращает
логическоеРеализация
Cake\View\Form\ContextInterface::isPrimaryKey() isRequired()source public
isRequired( string $field )
Проверить, является ли заданное поле обязательным.
Параметры
- строка
$field - Путь с разделителями «точка» для проверки обязательности.
Возвращает
логическоеРеализация
Cake\View\Form\ContextInterface::isRequired() primaryKey()source public
primaryKey( )
Получить поля, используемые в контексте, как первичный ключ.
Возвращает
массивРеализация
Cake\View\Form\ContextInterface::primaryKey() type()source public
type( string $field )
Получить абстрактный тип поля для заданного имени поля.
Параметры
- строка
$field - Путь с разделителями «точка» для получения типа схемы.
Возвращает
null|строкаАбстрактный тип данных или null.
Реализация
Cake\View\Form\ContextInterface::type() val()source public
val( string $field , $options [] )
Получить текущее значение для заданного поля.
Параметры
- строка
$field Путь с разделителями «точка» до поля, для которого требуется значение.
-
$optionsнеобязательно []
Возвращает
смешанноеРеализация
Cake\View\Form\ContextInterface::val() Подробное описание свойств
© 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.FormContext.html