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.
- Cake\Form\Form implements Cake\Event\EventListenerInterface, Cake\Event\EventDispatcherInterface, Cake\Validation\ValidatorAwareInterface uses Cake\Event\EventDispatcherTrait , Cake\Validation\ValidatorAwareTrait
Constants summary
Inherited Constants
Properties summary
-
$_dataprotectedarrayForm's data. -
$_errorsprotectedarrayThe errors if any -
$_schemaprotectedThe schema used by this form. -
$_schemaClassprotectedstringSchema class. -
$_validatorprotectedThe validator used by this form.
Inherited Properties
Method Summary
-
__construct() public
Constructor -
__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. -
buildValidator() public
Callback method for Form.buildValidator event. -
errors() public
Get the errors in the form -
execute() public
Execute the form if it is valid. -
getData() public
Get field data. -
getErrors() public
Get the errors in the form -
implementedEvents() public
Get the Form callbacks this form is interested in. -
schema() public
Get/Set the schema for this form. -
setData() public
Set form data. -
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
__construct() public ¶
__construct( Cake\Event\EventManager $eventManager null )
Constructor
Parameters
-
Cake\Event\EventManager$eventManager optional null The event manager. Defaults to a new instance.
_buildSchema() protected ¶
_buildSchema( Cake\Form\Schema $schema )
A 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
_buildValidator() protected ¶
_buildValidator( Cake\Validation\Validator $validator )
A 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.
Deprecated
Parameters
-
Cake\Validation\Validator$validator - The validator to customize.
Returns
_execute() protected ¶
_execute( array $data )
Hook method to be implemented in subclasses.
Used by execute() to execute the form's action.
Parameters
- array $data
- Form data.
Returns
buildValidator() public ¶
buildValidator( Cake\Event\Event $event , Cake\Validation\Validator $validator , string $name )
Callback method for Form.buildValidator event.
Parameters
-
Cake\Event\Event$event - The Form.buildValidator event instance.
-
Cake\Validation\Validator$validator - The validator to customize.
- string $name
- Validator name
errors() public ¶
errors( )
Get the errors in the form
Will return the errors from the last call
to validate() or execute().
Deprecated
Returns
Last set validation errors.
execute() public ¶
execute( array $data )
Execute 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
False on validation failure, otherwise returns the
result of the _execute() method.
getData() public ¶
getData( string|null $field null )
Get field data.
Parameters
- string|null $field optional null
The field name or null to get data array with all fields.
Returns
Since
getErrors() public ¶
getErrors( )
Get the errors in the form
Will return the errors from the last call
to validate() or execute().
Returns
Last set validation errors.
implementedEvents() public ¶
implementedEvents( )
Get the Form callbacks this form is interested in.
The conventional method map is:
- Form.buildValidator => buildValidator
Returns
Implementation of
schema() public ¶
schema( Cake\Form\Schema $schema null )
Get/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$schema optional null - The schema to set, or null.
Returns
setData() public ¶
setData( array $data )
Set form data.
Parameters
- array $data
- Data array.
Returns
$this
Since
setErrors() public ¶
setErrors( array $errors )
Set the errors in the form.
$errors = [ 'field_name' => ['rule_name' => 'message'] ]; $form->setErrors($errors);
Parameters
- array $errors
- Errors list.
Returns
$this
Since
validate() public ¶
validate( array $data )
Used to check if $data passes this form's validation.
Parameters
- array $data
- The data to check.
Returns
Whether or not the data is valid.
validator() public ¶
validator( Cake\Validation\Validator $validator null )
Get/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.
Deprecated
Parameters
-
Cake\Validation\Validator$validator optional null - The validator to set, or null.
Returns
Methods used from Cake\Event\EventDispatcherTrait
dispatchEvent() public ¶
dispatchEvent( string $name , array|null $data null , object|null $subject null )
Wrapper for creating and dispatching events.
Returns a dispatched event.
Parameters
- string $name
- Name of the event.
- array|null $data optional null
Any value you wish to be transported with this event to it can be read by listeners.
- object|null $subject optional null
The object that this event applies to ($this by default).
Returns
eventManager() public ¶
eventManager( Cake\Event\EventManager $eventManager null )
Returns the Cake\Event\EventManager manager instance for this object.
You can use this instance to register any new listeners or callbacks to the object events, or create your own events and trigger them at will.
Deprecated
Parameters
-
Cake\Event\EventManager$eventManager optional null - the eventManager to set
Returns
getEventManager() public ¶
getEventManager( )
Returns the Cake\Event\EventManager manager instance for this object.
You can use this instance to register any new listeners or callbacks to the object events, or create your own events and trigger them at will.
Returns
setEventManager() public ¶
setEventManager( Cake\Event\EventManager $eventManager )
Returns the Cake\Event\EventManager manager instance for this object.
You can use this instance to register any new listeners or callbacks to the object events, or create your own events and trigger them at will.
Parameters
-
Cake\Event\EventManager$eventManager - the eventManager to set
Returns
$this
Methods used from Cake\Validation\ValidatorAwareTrait
createValidator() protected ¶
createValidator( string $name )
Creates a validator using a custom method inside your class.
This method is used only to build a new validator and it does not store it in your object. If you want to build and reuse validators, use getValidator() method instead.
Parameters
- string $name
- The name of the validation set to create.
Returns
Throws
getValidator() public ¶
getValidator( string|null $name null )
Returns the validation rules tagged with $name. It is possible to have multiple different named validation sets, this is useful when you need to use varying rules when saving from different routines in your system.
If a validator has not been set earlier, this method will build a valiator using a method inside your class.
For example, if you wish to create a validation set called 'forSubscription', you will need to create a method in your Table subclass as follows:
public function validationForSubscription($validator) { return $validator ->add('email', 'valid-email', ['rule' => 'email']) ->add('password', 'valid', ['rule' => 'notBlank']) ->requirePresence('username'); } $validator = $this->getValidator('forSubscription');
You can implement the method in validationDefault in your Table subclass
should you wish to have a validation set that applies in cases where no other
set is specified.
If a $name argument has not been provided, the default validator will be returned.
You can configure your default validator name in a DEFAULT_VALIDATOR
class constant.
Parameters
- string|null $name optional null
- The name of the validation set to return.
Returns
hasValidator() public ¶
hasValidator( string $name )
Checks whether or not a validator has been set.
Parameters
- string $name
- The name of a validator.
Returns
setValidator() public ¶
setValidator( string $name , Cake\Validation\Validator $validator )
This method stores a custom validator under the given name.
You can build the object by yourself and store it in your object:
$validator = new \Cake\Validation\Validator($table); $validator ->add('email', 'valid-email', ['rule' => 'email']) ->add('password', 'valid', ['rule' => 'notBlank']) ->allowEmpty('bio'); $this->setValidator('forSubscription', $validator);
Parameters
- string $name
- The name of a validator to be set.
-
Cake\Validation\Validator$validator - Validator object to be set.
Returns
$this
validationDefault() public ¶
validationDefault( Cake\Validation\Validator $validator )
Returns the default validator object. Subclasses can override this function to add a default validation set to the validator object.
Parameters
-
Cake\Validation\Validator$validator The validator that can be modified to add some rules to it.
Returns
validationMethodExists() protected ¶
validationMethodExists( string $name )
Checks if validation method exists.
Parameters
- string $name
- Validation method name.
Returns
Magic methods inherited from Cake\Event\EventDispatcherInterface
getEventManager()
|