Класс FormContext

Предоставляет поставщик контекста для экземпляров Cake\Form\Form.

Этот поставщик контекста просто выполняет требования интерфейса, которые имеет FormHelper, и позволяет получить доступ к данным запроса.

Cake\View\Form\FormContext реализует Cake\View\Form\ContextInterface

Пространство имён: Cake\View\Form
Расположение: View/Form/FormContext.php

Краткое описание свойств

$_form protected

Cake\Form\Form
Объект формы.
$_request protected

Cake\Http\ServerRequest
Объект запроса.

Краткое описание методов

__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: Имя поля.

Возвращает

mixed

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()

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: Путь через точки к полю, для которого требуется значение.
$options optional []

Возвращает

mixed

Реализация

Cake\View\Form\ContextInterface::val()

Магические методы, унаследованные от Cake\View\Form\ContextInterface

getMaxLength(), getRequiredMessage()

Подробное описание свойств

$_formsource

protected Cake\Form\Form

Объект формы.

$_requestsource

protected Cake\Http\ServerRequest

Объект запроса.

© 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.8/class-Cake.View.Form.FormContext.html