Spec-Zone.ru › CakePHP 3.1

Класс Form

Абстракция формы, используемая для создания форм, не привязанных к моделям ORM или другим постоянным хранилищам данных. Идеально подходит для реализации форм на основе API-сервисов или форм обратной связи.

Создание формы

Этот класс наиболее полезен при наследовании. В подклассе вы должны определить методы _buildSchema, _buildValidator и необязательно _execute. Они позволяют объявить поля формы, валидацию и основное действие соответственно.

Вы также можете определить валидацию и схему, вызывая методы от $form->schema() и $form->validator().

Формы обычно размещаются в пространстве имен App\Form.

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

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

__debugInfosource public

__debugInfo( )

Получить печатную версию экземпляра Form.

Возвращает

array
массив

_buildSchemasource protected

_buildSchema( Cake\Form\Schema $schema )

Метод-обработчик, предназначенный для реализации подклассами.

Вы можете использовать этот метод для определения схемы, используя методы в Cake\Form\Schema, или загрузить предопределённую схему из конкретного класса.

Параметры

Cake\Form\Schema $schema
Схема для настройки.

Возвращает

Cake\Form\Schema
Используемая схема.

_buildValidatorsource protected

_buildValidator( Cake\Validation\Validator $validator )

Метод-обработчик, предназначенный для реализации подклассами.

Вы можете использовать этот метод для определения валидатора, используя методы в Cake\Validation\Validator, или загрузить предопределённый валидатор из конкретного класса.

Параметры

Cake\Validation\Validator $validator
Валидатор для настройки.

Возвращает

Cake\Validation\Validator
Используемый валидатор.

_executesource protected

_execute( array $data )

Метод-обработчик для реализации в подклассах.

Используется execute() для выполнения действия формы.

Параметры

массив $data
Данные формы.

Возвращает

boolean
bool

errorssource public

errors( )

Получить ошибки в форме

Возвращает ошибки из последнего вызова validate() или execute().

Возвращает

array
Последние установленные ошибки валидации.

executesource public

execute( array $data )

Выполнить форму, если она валидна.

Сначала валидирует форму, затем вызывает метод-обработчик _execute(). Этот метод-обработчик может быть реализован в подклассах для выполнения действия формы. Это может быть отправка электронной почты, взаимодействие с удалённым API или что-то ещё, что вам может потребоваться.

Параметры

массив $data
Данные формы.

Возвращает

boolean
False при ошибке валидации, иначе возвращает результат метода _execute().

schemasource public

schema( Cake\Form\Schema $schema null )

Получить/установить схему для этой формы.

Этот метод вызовет _buildSchema() при первом построении схемы. Этот метод-обработчик позволяет настроить схему или загрузить предопределённую схему.

Параметры

Cake\Form\Schema $schema необязательно null
Схема для установки, или null.

Возвращает

Cake\Form\Schema
экземпляр схемы.

validatesource public

validate( array $data )

Используется для проверки, проходит ли $data валидацию этой формы.

Параметры

массив $data
Данные для проверки.

Возвращает

boolean
Являются ли данные валидными.

validatorsource public

validator( Cake\Validation\Validator $validator null )

Получить/установить валидатор для этой формы.

Этот метод вызовет _buildValidator() при первом построении валидатора. Этот метод-обработчик позволяет настроить валидатор или загрузить предопределённый.

Параметры

Cake\Validation\Validator $validator необязательно null
Валидатор для установки, или null.

Возвращает

Cake\Validation\Validator
экземпляр валидатора.

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

$_errorssource

protected массив

Возможные ошибки

[]

$_schemasource

protected Cake\Form\Schema;

Схема, используемая этой формой.

$_validatorsource

protected Cake\Validation\Validator;

Валидатор, используемый этой формой.

© 2005–2016 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.
http://api.cakephp.org/3.1/class-Cake.Form.Form.html

Spec-Zone.ru

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