Класс Form
Абстракция формы, используемая для создания форм, не связанных с моделями ORM или другими постоянными хранилищами данных. Идеально подходит для реализации форм на основе API-сервисов или контактных форм.
Создание формы
Этот класс наиболее полезен при наследовании. В подклассе вы должны определить методы _buildSchema, _buildValidator и необязательно _execute. Они позволяют объявить поля формы, валидацию и основное действие соответственно.
Вы также можете определить валидацию и схему, вызывая методы из $form->schema() и $form->validator().
Формы обычно размещаются в пространстве имён App\Form.
Краткое описание свойств
-
$_errorsprotectedОшибки, если таковые имеютсяarray - Схема, используемая этой формой.
$_schemaprotected -
$_schemaClassprotectedКласс схемы.string - Валидатор, используемый этой формой.
$_validatorprotected
Краткое описание методов
- __debugInfo() publicПолучение печатной версии экземпляра Form.
- _buildSchema() protectedМетод-обработчик, предназначенный для реализации в подклассах.
- _buildValidator() protectedМетод-обработчик, предназначенный для реализации в подклассах.
- _execute() protectedМетод-обработчик, подлежащий реализации в подклассах.
- errors() publicПолучение ошибок в форме
- execute() publicВыполнение формы, если она валидна.
- schema() publicПолучение/Установка схемы для данной формы.
- setErrors() 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экземпляр схемы.
setErrors()source public
setErrors( array $errors )
Установка ошибок в форме.
$errors = [
'field_name' => ['rule_name' => 'message']
];
$form->setErrors($errors); Параметры
- массив
$errors - Список ошибок.
Возвращает
$this
С тех пор как
3.5.1validate()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–2018 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.5/class-Cake.Form.Form.html