Defines an interface for Plugin UI plugins.
@todo This needs a lot more explanation.
Expanded class hierarchy of PluginUIInterface
All classes that implement PluginUIInterface
interface PluginUIInterface {
/**
* Creates a form array.
*
* @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
* Returns the form structure as an array.
*
* @todo Creates a form array for what?
*/
public function form($form, &$form_state);
/**
* Validates form values from the form() method.
*
* @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 formValidate($form, &$form_state);
/**
* Submits form values from the form() method.
*
* @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 formSubmit($form, &$form_state);
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
PluginUIInterface:: |
public | function | Creates a form array. | 1 |
PluginUIInterface:: |
public | function | Submits form values from the form() method. | 1 |
PluginUIInterface:: |
public | function | Validates form values from the form() method. | 1 |