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.
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.
string
'Form.buildValidator'
string
'form'
$_errors
protected array
$_schema
protected $_schemaClass
protected string
$_validator
protected __construct( Cake\Event\EventManager $eventManager null )
Constructor
Cake\Event\EventManager
$eventManager
optional null The event manager. Defaults to a new instance.
__debugInfo( )
Get the printable version of a Form instance.
_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.
Cake\Form\Schema
$schema
Cake\Form\Schema
_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.
Cake\Validation\Validator
$validator
Cake\Validation\Validator
_execute( array $data )
Hook method to be implemented in subclasses.
Used by execute()
to execute the form's action.
$data
buildValidator( Cake\Event\Event $event , Cake\Validation\Validator $validator , string $name )
Callback method for Form.buildValidator event.
Cake\Event\Event
$event
Cake\Validation\Validator
$validator
$name
errors( )
Get the errors in the form
Will return the errors from the last call to validate()
or execute()
.
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.
$data
False on validation failure, otherwise returns the result of the _execute()
method.
implementedEvents( )
Get the Form callbacks this form is interested in.
The conventional method map is:
Cake\Event\EventListenerInterface::implementedEvents()
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.
Cake\Form\Schema
$schema
optional null Cake\Form\Schema
setErrors( array $errors )
Set the errors in the form.
$errors = [ 'field_name' => ['rule_name' => 'message'] ]; $form->setErrors($errors);
$errors
validate( array $data )
Used to check if $data passes this form's validation.
$data
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.
Cake\Validation\Validator
$validator
optional null Cake\Validation\Validator
dispatchEvent( string $name , array|null $data null , object|null $subject null )
Wrapper for creating and dispatching events.
Returns a dispatched event.
$name
$data
optional null Any value you wish to be transported with this event to it can be read by listeners.
$subject
optional null The object that this event applies to ($this by default).
Cake\Event\Event
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.
Cake\Event\EventManager
$eventManager
optional null Cake\Event\EventManager
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.
Cake\Event\EventManager
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.
Cake\Event\EventManager
$eventManager
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.
$name
Cake\Validation\Validator
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.
$name
optional null Cake\Validation\Validator
hasValidator( string $name )
Checks whether or not a validator has been set.
$name
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);
$name
Cake\Validation\Validator
$validator
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.
Cake\Validation\Validator
$validator
The validator that can be modified to add some rules to it.
Cake\Validation\Validator
validationMethodExists( string $name )
Checks if validation method exists.
$name
getEventManager() |
© 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.6/class-Cake.Form.Form.html