interface EntityFormWizardInterface in Chaos Tool Suite (ctools) 8.3
Form wizard interface for use with entities.
Hierarchy
- interface \Drupal\Core\Form\FormInterface
- interface \Drupal\ctools\Wizard\FormWizardInterface
- interface \Drupal\ctools\Wizard\EntityFormWizardInterface
- interface \Drupal\ctools\Wizard\FormWizardInterface
Expanded class hierarchy of EntityFormWizardInterface
All classes that implement EntityFormWizardInterface
File
- src/
Wizard/ EntityFormWizardInterface.php, line 8
Namespace
Drupal\ctools\WizardView source
interface EntityFormWizardInterface extends FormWizardInterface {
/**
* The fieldset #title for your label & machine name elements.
*
* @return string
*/
public function getWizardLabel();
/**
* The form element #title for your unique identifier label.
*
* @return string
*/
public function getMachineLabel();
/**
* The machine name of the entity type.
*
* @return string
*/
public function getEntityType();
/**
* A method for determining if this entity already exists.
*
* @return callable
* The callable to pass the id to via typical machine_name form element.
*/
public function exists();
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
EntityFormWizardInterface:: |
public | function | A method for determining if this entity already exists. | 1 |
EntityFormWizardInterface:: |
public | function | The machine name of the entity type. | 1 |
EntityFormWizardInterface:: |
public | function | The form element #title for your unique identifier label. | 1 |
EntityFormWizardInterface:: |
public | function | The fieldset #title for your label & machine name elements. | 1 |
FormInterface:: |
public | function | Form constructor. | 179 |
FormInterface:: |
public | function | Returns a unique string identifying the form. | 236 |
FormInterface:: |
public | function | Form submission handler. | 192 |
FormInterface:: |
public | function | Form validation handler. | 30 |
FormWizardInterface:: |
public | function | 1 | |
FormWizardInterface:: |
public | function | 1 | |
FormWizardInterface:: |
public | function | 1 | |
FormWizardInterface:: |
public | function | Form submit handler for finalizing the wizard values. | 1 |
FormWizardInterface:: |
public | function | The SharedTempStore key for our current wizard values. | 1 |
FormWizardInterface:: |
public | function | The Route parameters for a 'next' step. | 1 |
FormWizardInterface:: |
public | function | Retrieve the current Operation. | 1 |
FormWizardInterface:: |
public | function | Retrieve a list of FormInterface classes by their step key in the wizard. | 2 |
FormWizardInterface:: |
public static | function | Return an array of parameters required to construct this wizard. | 1 |
FormWizardInterface:: |
public | function | The Route parameters for a 'previous' step. | 1 |
FormWizardInterface:: |
public | function | The name of the route to which forward or backwards steps redirect. | 1 |
FormWizardInterface:: |
public | function | Retrieve the current active step of the wizard. | 1 |
FormWizardInterface:: |
public | function | The active SharedTempStore for this wizard. | 1 |
FormWizardInterface:: |
public | function | The shared temp store factory collection name. | 1 |
FormWizardInterface:: |
public | function | Initialize wizard values. | 1 |
FormWizardInterface:: |
constant | Constant value for wizard load event. | ||
FormWizardInterface:: |
public | function | Form validation handler that populates the cached values from tempstore. | 1 |
FormWizardInterface:: |
public | function | Form submit handler to step backwards in the wizard. | 1 |