Spec-Zone.ru › CakePHP 3.7

Класс 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.7/class-Cake.View.Form.FormContext.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API