class WizardParameters in Flexiform 8

Plugin for adding Wizard Parameters into the Flexiform entity manager.

Plugin annotation

@FormEnhancer(
  id = "wizard_parameters",
  label = @Translation("Wizard Parameters"),
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\flexiform\FormEnhancer\FormEnhancerBase implements FormEnhancerInterface
      • class \Drupal\flexiform_wizard\Plugin\FormEnhancer\WizardParameters

File

contrib/wizard/src/Plugin/FormEnhancer/WizardParameters.php, line 15

Namespace

Drupal\flexiform_wizard\Plugin\FormEnhancer

class WizardParameters extends FormEnhancerBase {

  /**
   * {@inheritdoc}
   */
  public function applies($event) {
    if ($event != 'init_form_entity_config') {
      return FALSE;
    }
    return substr($this
      ->getFormDisplay()
      ->id(), 0, 17) == 'flexiform_wizard.';
  }

  /**
   * Initialise the enhancer config..
   *
   * @return array
   *   The initial config for the enhancer.
   */
  public function initFormEntityConfig() {
    list(, $wizard_id, $step) = explode('.', $this
      ->getFormDisplay()
      ->id(), 3);
    $wizard = entity_load('flexiform_wizard', $wizard_id);
    $form_entity_settings = [];
    foreach ($wizard
      ->get('parameters') as $param_name => $param_info) {
      $form_entity_settings[$param_name] = [
        'entity_type' => $param_info['entity_type'],
        'bundle' => $param_info['bundle'],
        'plugin' => 'provided',
        'label' => $param_info['label'],
      ];
    }
    return $form_entity_settings;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
FormEnhancerBase::$formDisplay	protected	property	The form display entity.
FormEnhancerBase::$supportedEvents	protected	property	An array of supported events.	5
FormEnhancerBase::getFormDisplay	protected	function	Get the form display.
FormEnhancerBase::setFormDisplay	public	function	Set the form display object. Overrides FormEnhancerInterface::setFormDisplay
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
WizardParameters::applies	public	function	Whether this enhancer applies to a particular event. Overrides FormEnhancerBase::applies
WizardParameters::initFormEntityConfig	public	function	Initialise the enhancer config..