Класс FormContext
Предоставляет контекст-провайдер для экземпляров Cake\Form\Form.
Этот контекст-провайдер просто выполняет требования интерфейса, которые имеет FormHelper, и позволяет получить доступ к данным запроса.
- Cake\View\Form\FormContext реализует Cake\View\Form\ContextInterface
Краткое описание свойств
Краткое описание методов
- __construct() publicКонструктор.
- _schemaDefault() protectedПолучение значения по умолчанию из схемы формы для заданного поля.
- attributes() publicПолучение ассоциативного массива дополнительных атрибутов для имени поля.
- error() publicПолучение сообщений об ошибках для заданного поля.
- fieldNames() publicПолучение имён полей верхнего уровня в данном контексте.
- getMaxLength() public
- getRequiredMessage() public
- hasError() publicПроверка наличия ошибки для поля.
- isCreate() publicВозвращает true, если форма предназначена для операции создания.
- 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 - Информация контекста.
_schemaDefault()source protected
_schemaDefault( string $field )
Получение значения по умолчанию из схемы формы для заданного поля.
Параметры
- строка
$field - Имя поля.
Возвращает
mixedattributes()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() getMaxLength()source public
getMaxLength( $field )
getRequiredMessage()source public
getRequiredMessage( $field )
hasError()source public
hasError( string $field )
Проверка наличия ошибки для поля
Параметры
- строка
$field - Путь через точки для проверки ошибок.
Возвращает
булевоВозвращает true, если ошибки для поля не пусты.
Реализация
Cake\View\Form\ContextInterface::hasError() isCreate()source public
isCreate( )
Возвращает true, если форма предназначена для операции создания.
Возвращает
булевоРеализация
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 Путь через точки к полю, для которого нужно получить значение.
-
$optionsoptional []
Возвращает
mixedРеализация
Cake\View\Form\ContextInterface::val() Магические методы, унаследованные от Cake\View\Form\ContextInterface
getMaxLength(), getRequiredMessage() |
Подробное описание свойств
© 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/3.7/class-Cake.View.Form.FormContext.html