interface EntityFormWizardInterface

Same name in other branches
  1. 8.x-3.x src/Wizard/EntityFormWizardInterface.php \Drupal\ctools\Wizard\EntityFormWizardInterface

Form wizard interface for use with entities.

Hierarchy

Expanded class hierarchy of EntityFormWizardInterface

All classes that implement EntityFormWizardInterface

File

src/Wizard/EntityFormWizardInterface.php, line 8

Namespace

Drupal\ctools\Wizard
View 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

Title Modifiers Object type Summary Overrides
EntityFormWizardInterface::exists public function A method for determining if this entity already exists. 1
EntityFormWizardInterface::getEntityType public function The machine name of the entity type. 1
EntityFormWizardInterface::getMachineLabel public function The form element #title for your unique identifier label. 1
EntityFormWizardInterface::getWizardLabel public function The fieldset #title for your label & machine name elements. 1
FormInterface::buildForm public function Form constructor. 203
FormInterface::getFormId public function Returns a unique string identifying the form. 284
FormInterface::submitForm public function Form submission handler. 229
FormInterface::validateForm public function Form validation handler. 34
FormWizardInterface::ajaxFinish public function 1
FormWizardInterface::ajaxPrevious public function 1
FormWizardInterface::ajaxSubmit public function 1
FormWizardInterface::finish public function Form submit handler for finalizing the wizard values. 1
FormWizardInterface::getMachineName public function The SharedTempStore key for our current wizard values. 1
FormWizardInterface::getNextParameters public function The Route parameters for a 'next' step. 1
FormWizardInterface::getOperation public function Retrieve the current Operation. 1
FormWizardInterface::getOperations public function Retrieve a list of FormInterface classes by their step key in the wizard. 2
FormWizardInterface::getParameters public static function Return an array of parameters required to construct this wizard. 1
FormWizardInterface::getPreviousParameters public function The Route parameters for a 'previous' step. 1
FormWizardInterface::getRouteName public function The name of the route to which forward or backwards steps redirect. 1
FormWizardInterface::getStep public function Retrieve the current active step of the wizard. 1
FormWizardInterface::getTempstore public function The active SharedTempStore for this wizard. 1
FormWizardInterface::getTempstoreId public function The shared temp store factory collection name. 1
FormWizardInterface::initValues public function Initialize wizard values. 1
FormWizardInterface::LOAD_VALUES constant Constant value for wizard load event.
FormWizardInterface::populateCachedValues public function Form validation handler that populates the cached values from tempstore. 1
FormWizardInterface::previous public function Form submit handler to step backwards in the wizard. 1