interface PluginWizardInterface

Same name in other branches
  1. 4.0.x src/Plugin/PluginWizardInterface.php \Drupal\ctools\Plugin\PluginWizardInterface

Provides an interface for configuring a plugin via wizard steps.

Hierarchy

Expanded class hierarchy of PluginWizardInterface

All classes that implement PluginWizardInterface

File

src/Plugin/PluginWizardInterface.php, line 8

Namespace

Drupal\ctools\Plugin
View source 
interface PluginWizardInterface {
    
    /**
     * Retrieve a list of FormInterface classes by their step key in the wizard.
     *
     * @param mixed $cached_values
     *   The cached values used in the wizard. The plugin we're editing will
     *    always be assigned to the 'plugin' key.
     *
     * @return array
     *   An associative array keyed on the step name with an array value with the
     *   following keys:
     *   - title (string): Human-readable title of the step.
     *   - form (string): Fully-qualified class name of the form for this step.
     */
    public function getWizardOperations($cached_values);

}

Members

Title Modifiers Object type Summary
PluginWizardInterface::getWizardOperations public function Retrieve a list of FormInterface classes by their step key in the wizard.