Класс FormContext
Предоставляет поставщик контекста для экземпляров Cake\Form\Form.
Этот поставщик контекста просто выполняет требования интерфейса, которые имеет FormHelper, и позволяет получить доступ к данным запроса.
- Cake\View\Form\FormContext реализует Cake\View\Form\ContextInterface
Краткое описание свойств
Краткое описание методов
- __construct() publicКонструктор.
- _schemaDefault() protectedПолучение значения по умолчанию из схемы формы для заданного поля.
- 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 - Информация контекста.
_schemaDefault()source protected
_schemaDefault( string $field )
Получение значения по умолчанию из схемы формы для заданного поля.
Параметры
- строка
$field - Имя поля.
Возвращаемое значение
смешанное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–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.6/class-Cake.View.Form.FormContext.html