Class Form
Form abstraction used to create forms not tied to ORM backed models, or to other permanent datastores. Ideal for implementing forms on top of API services, or contact forms.
Building a form
This class is most useful when subclassed. In a subclass you
should define the _buildSchema, _buildValidator and optionally,
the _execute methods. These allow you to declare your form's
fields, validation and primary action respectively.
You can also define the validation and schema by chaining method
calls off of $form->schema() and $form->validator().
Forms are conventionally placed in the App\Form namespace.
Property Summary
-
$_errors protected
arrayThe errors if any
-
$_schema protected
Cake\Form\SchemaThe schema used by this form.
-
$_schemaClass protected
stringSchema class.
-
$_validator protected
Cake\Validation\ValidatorThe validator used by this form.
Method Summary
-
__debugInfo() public
Get the printable version of a Form instance.
-
_buildSchema() protected
A hook method intended to be implemented by subclasses.
-
_buildValidator() protected
A hook method intended to be implemented by subclasses.
-
_execute() protected
Hook method to be implemented in subclasses.
-
errors() public
Get the errors in the form
-
execute() public
Execute the form if it is valid.
-
schema() public
Get/Set the schema for this form.
-
setErrors() public
Set the errors in the form.
-
validate() public
Used to check if $data passes this form's validation.
-
validator() public
Get/Set the validator for this form.
Method Detail
__debugInfo() ¶ public
__debugInfo(): arrayGet the printable version of a Form instance.
Returns
array_buildSchema() ¶ protected
_buildSchema(Cake\Form\Schema $schema): Cake\Form\SchemaA hook method intended to be implemented by subclasses.
You can use this method to define the schema using the methods on Cake\Form\Schema, or loads a pre-defined schema from a concrete class.
Parameters
-
Cake\Form\Schema$schema The schema to customize.
Returns
Cake\Form\Schema_buildValidator() ¶ protected
_buildValidator(Cake\Validation\Validator $validator): Cake\Validation\ValidatorA hook method intended to be implemented by subclasses.
You can use this method to define the validator using the methods on Cake\Validation\Validator or loads a pre-defined validator from a concrete class.
Parameters
-
Cake\Validation\Validator$validator The validator to customize.
Returns
Cake\Validation\Validator_execute() ¶ protected
_execute(array $data): boolHook method to be implemented in subclasses.
Used by execute() to execute the form's action.
Parameters
-
array$data Form data.
Returns
boolerrors() ¶ public
errors(): arrayGet the errors in the form
Will return the errors from the last call
to validate() or execute().
Returns
arrayexecute() ¶ public
execute(array $data): boolExecute the form if it is valid.
First validates the form, then calls the _execute() hook method.
This hook method can be implemented in subclasses to perform
the action of the form. This may be sending email, interacting
with a remote API, or anything else you may need.
Parameters
-
array$data Form data.
Returns
boolschema() ¶ public
schema(Cake\Form\Schema|null $schema = null): Cake\Form\SchemaGet/Set the schema for this form.
This method will call _buildSchema() when the schema
is first built. This hook method lets you configure the
schema or load a pre-defined one.
Parameters
-
Cake\Form\Schema|null$schema optional The schema to set, or null.
Returns
Cake\Form\SchemasetErrors() ¶ public
setErrors(array $errors): $thisSet the errors in the form.
$errors = [
'field_name' => ['rule_name' => 'message']
];
$form->setErrors($errors);Parameters
-
array$errors Errors list.
Returns
$thisvalidate() ¶ public
validate(array $data): boolUsed to check if $data passes this form's validation.
Parameters
-
array$data The data to check.
Returns
boolvalidator() ¶ public
validator(Cake\Validation\Validator|null $validator = null): Cake\Validation\ValidatorGet/Set the validator for this form.
This method will call _buildValidator() when the validator
is first built. This hook method lets you configure the
validator or load a pre-defined one.
Parameters
-
Cake\Validation\Validator|null$validator optional The validator to set, or null.
Returns
Cake\Validation\Validator