Класс Form
Абстракция формы, используемая для создания форм, не привязанных к моделям ORM или другим постоянным хранилищам данных. Идеально подходит для реализации форм на основе API-сервисов или контактных форм.
Создание формы
Этот класс наиболее полезен при наследовании. В подклассе вы должны определить методы _buildSchema, _buildValidator и необязательно _execute. Они позволяют объявить поля формы, валидацию и основное действие соответственно.
Также можно определить валидацию и схему, вызывая методы от $form->schema() и $form->validator().
Формы обычно размещаются в пространстве имён App\Form.
Краткое описание свойств
-
$_errorsprotectedОшибки, если таковые имеютсяarray -
$_schemaprotectedСхема, используемая этой формой.Cake\Form\Schema; -
$_validatorprotectedВалидатор, используемый этой формой.Cake\Validation\Validator;
Краткое описание методов
- __debugInfo() publicПолучение печатной версии экземпляра Form.
- _buildSchema() protectedМетод-обработчик, предназначенный для реализации в подклассах.
- _buildValidator() protectedМетод-обработчик, предназначенный для реализации в подклассах.
- _execute() protectedМетод-обработчик, подлежащий реализации в подклассах.
- errors() publicПолучение ошибок в форме
- execute() publicВыполнение формы, если она валидна.
- schema() publicПолучение/установка схемы для этой формы.
- validate() publicИспользуется для проверки, соответствует ли $data валидации этой формы.
- validator() publicПолучение/установка валидатора для этой формы.
Подробное описание методов
__debugInfo()source public
__debugInfo( )
Получение печатной версии экземпляра Form.
Возвращаемое значение
массив_buildSchema()source protected
_buildSchema( Cake\Form\Schema $schema )
Метод-обработчик, предназначенный для реализации в подклассах.
Можно использовать этот метод для определения схемы, используя методы Cake\Form\Schema, или загрузить предопределённую схему из конкретного класса.
Параметры
-
Cake\Form\Schema$schema - Схема для настройки.
Возвращаемое значение
Cake\Form\SchemaИспользуемая схема.
_buildValidator()source protected
_buildValidator( Cake\Validation\Validator $validator )
Метод-обработчик, предназначенный для реализации в подклассах.
Можно использовать этот метод для определения валидатора, используя методы Cake\Validation\Validator или загрузить предопределённый валидатор из конкретного класса.
Параметры
-
Cake\Validation\Validator$validator - Валидатор для настройки.
Возвращаемое значение
Cake\Validation\ValidatorИспользуемый валидатор.
_execute()source protected
_execute( array $data )
Метод-обработчик, подлежащий реализации в подклассах.
Используется методом execute() для выполнения действия формы.
Параметры
- массив
$data - Данные формы.
Возвращаемое значение
логическое значениеerrors()source public
errors( )
Получение ошибок в форме
Возвращает ошибки с последнего вызова validate() или execute().
Возвращаемое значение
массивПоследние установленные ошибки валидации.
execute()source public
execute( array $data )
Выполнение формы, если она валидна.
Сначала выполняется валидация формы, затем вызывается метод-обработчик _execute(). Этот метод-обработчик может быть реализован в подклассах для выполнения действия формы. Это может быть отправка электронной почты, взаимодействие с удалённым API или что-либо ещё, что может потребоваться.
Параметры
- массив
$data - Данные формы.
Возвращаемое значение
логическое значениеВозвращает false при ошибке валидации, в противном случае возвращает результат метода _execute().
schema()source public
schema( Cake\Form\Schema $schema null )
Получение/установка схемы для этой формы.
Этот метод вызовет _buildSchema() при первом создании схемы. Этот метод-обработчик позволяет настроить схему или загрузить предварительно определённую.
Параметры
-
Cake\Form\Schema$schemaнеобязательно null - Устанавливаемая схема или null.
Возвращаемое значение
Cake\Form\Schemaэкземпляр схемы.
validate()source public
validate( array $data )
Используется для проверки, соответствует ли $data валидации этой формы.
Параметры
- массив
$data - Данные для проверки.
Возвращаемое значение
логическое значениеРезультат проверки данных.
validator()source public
validator( Cake\Validation\Validator $validator null )
Получение/установка валидатора для этой формы.
Этот метод вызовет _buildValidator() при первом создании валидатора. Этот метод-обработчик позволяет настроить валидатор или загрузить предварительно определённый.
Параметры
-
Cake\Validation\Validator$validatorнеобязательно null - Устанавливаемый валидатор или null.
Возвращаемое значение
Cake\Validation\Validatorэкземпляр валидатора.
Подробное описание свойств
© 2005–2017 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.3/class-Cake.Form.Form.html