Класс Form
Абстракция формы, используемая для создания форм, не связанных с моделями ORM или другими постоянными хранилищами данных. Идеально подходит для реализации форм на основе API-сервисов или контактных форм.
Создание формы
Этот класс наиболее полезен при наследовании. В подклассе вы должны определить методы _buildSchema, _buildValidator и необязательно _execute. Они позволяют объявить поля вашей формы, валидацию и основное действие соответственно.
Вы также можете определить валидацию и схему, вызывая методы из $form->schema() и $form->validator().
Формы обычно размещаются в пространстве имен App\Form.
Краткое описание свойств
-
$_errorsprotectedОшибки, если таковые имеютсяarray - Схема, используемая этой формой.
$_schemaprotected - Валидатор, используемый этой формой.
$_validatorprotected
Краткое описание методов
- __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.
Возвращает
array_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 - Данные формы.
Возвращает
booleanerrors()source public
errors( )
Получить ошибки в форме
Возвращает ошибки из последнего вызова validate() или execute().
Возвращает
arrayПоследние установленные ошибки валидации.
execute()source public
execute( array $data )
Выполнить форму, если она валидна.
Сначала проверяет валидность формы, затем вызывает метод-обработчик _execute(). Этот метод-обработчик может быть реализован в подклассах для выполнения действия формы. Это может быть отправка электронной почты, взаимодействие с удаленным API или что-либо еще, что вам может потребоваться.
Параметры
- массив
$data - Данные формы.
Возвращает
booleanВозвращает 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 - Данные для проверки.
Возвращает
booleanРезультат проверки данных.
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.4/class-Cake.Form.Form.html