Provides an interface for a Form.
Expanded class hierarchy of FormInterface
All classes that implement FormInterface
interface FormInterface {
/**
* Returns a unique string identifying the form.
*
* @return string
* The unique string identifying the form.
*/
public function getFormID();
/**
* Form constructor.
*
* @param array $form
* An associative array containing the structure of the form.
* @param array $form_state
* An associative array containing the current state of the form.
*
* @return array
* The form structure.
*/
public function buildForm(array $form, array &$form_state);
/**
* Form validation handler.
*
* @param array $form
* An associative array containing the structure of the form.
* @param array $form_state
* An associative array containing the current state of the form.
*/
public function validateForm(array &$form, array &$form_state);
/**
* Form submission handler.
*
* @param array $form
* An associative array containing the structure of the form.
* @param array $form_state
* An associative array containing the current state of the form.
*/
public function submitForm(array &$form, array &$form_state);
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
FormInterface:: |
public | function | Form constructor. | 36 |
FormInterface:: |
public | function | Returns a unique string identifying the form. | 90 |
FormInterface:: |
public | function | Form submission handler. | 55 |
FormInterface:: |
public | function | Form validation handler. | 27 |