class PluginConfiguration in Commerce Core 8.2

Same name in this branch

8.2 src/Element/PluginConfiguration.php \Drupal\commerce\Element\PluginConfiguration
8.2 src/Plugin/Commerce/InlineForm/PluginConfiguration.php \Drupal\commerce\Plugin\Commerce\InlineForm\PluginConfiguration

Provides a plugin configuration inline form.

If the plugin belongs to an entity, it's the embedding form's responsibility to set the submitted configuration on the entity's plugin.

Plugin annotation


@CommerceInlineForm(
  id = "plugin_configuration",
  label = @Translation("Plugin configuration"),
)

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\commerce\Plugin\Commerce\InlineForm\InlineFormBase implements InlineFormInterface, ContainerFactoryPluginInterface uses AjaxFormTrait
    class \Drupal\commerce\Plugin\Commerce\InlineForm\PluginConfiguration uses CommerceElementTrait

Expanded class hierarchy of PluginConfiguration

File

src/Plugin/Commerce/InlineForm/PluginConfiguration.php, line 23

Namespace

Drupal\commerce\Plugin\Commerce\InlineForm

View source

class PluginConfiguration extends InlineFormBase {
  use CommerceElementTrait;

  /**
   * The plugin manager.
   *
   * @var \Drupal\Core\Executable\ExecutableManagerInterface
   */
  protected $pluginManager;

  /**
   * Constructs a new PluginConfiguration object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Component\Plugin\PluginManagerInterface $plugin_manager
   *   The plugin manager interface.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, PluginManagerInterface $plugin_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this
      ->setConfiguration($configuration);
    $this
      ->validateConfiguration();
    $this->pluginManager = $plugin_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('plugin.manager.' . $configuration['plugin_type']));
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'plugin_type' => '',
      'plugin_id' => '',
      'plugin_configuration' => [],
      'enforce_unique_parents' => TRUE,
    ];
  }

  /**
   * {@inheritdoc}
   */
  protected function requiredConfiguration() {
    return [
      'plugin_type',
      'plugin_id',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildInlineForm(array $inline_form, FormStateInterface $form_state) {
    assert(!empty($this->configuration['plugin_type']));
    assert(!empty($this->configuration['plugin_id']));
    assert(is_array($this->configuration['plugin_configuration']));
    $inline_form['form'] = [];
    $inline_form = parent::buildInlineForm($inline_form, $form_state);

    // NestedArray::setValue() crashes when switching between two plugins
    // that share a configuration element of the same name, but not the
    // same type (e.g. "amount" of type number/commerce_price).
    // Configuration must be keyed by plugin ID in $form_state to prevent
    // that, either on this level, or in a parent form element.
    if ($this->configuration['enforce_unique_parents']) {
      $inline_form['form']['#parents'] = array_merge($inline_form['#parents'], [
        $this->configuration['plugin_id'],
      ]);
    }
    $plugin = $this->pluginManager
      ->createInstance($this->configuration['plugin_id'], $this->configuration['plugin_configuration']);
    $inline_form['form'] = $plugin
      ->buildConfigurationForm($inline_form['form'], $form_state);
    return $inline_form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateInlineForm(array &$inline_form, FormStateInterface $form_state) {
    parent::validateInlineForm($inline_form, $form_state);
    $plugin = $this->pluginManager
      ->createInstance($this->configuration['plugin_id'], $this->configuration['plugin_configuration']);
    $plugin
      ->validateConfigurationForm($inline_form['form'], $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitInlineForm(array &$inline_form, FormStateInterface $form_state) {
    parent::submitInlineForm($inline_form, $form_state);
    $plugin = $this->pluginManager
      ->createInstance($this->configuration['plugin_id'], $this->configuration['plugin_configuration']);
    $plugin
      ->submitConfigurationForm($inline_form['form'], $form_state);
    $form_state
      ->setValueForElement($inline_form, $plugin
      ->getConfiguration());
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AjaxFormTrait::ajaxRefreshForm	public static	function	Ajax handler for refreshing an entire form.
CommerceElementTrait::attachElementSubmit	public static	function	Attaches the #commerce_element_submit functionality.
CommerceElementTrait::doExecuteSubmitHandlers	protected static	function	Calls the #commerce_element_submit callbacks recursively.
CommerceElementTrait::executeElementSubmitHandlers	public static	function	Submits elements by calling their #commerce_element_submit callbacks.
CommerceElementTrait::shouldExecuteElementSubmit	protected static	function	Checks whether #commerce_element_submit callbacks should be executed.
CommerceElementTrait::validateElementSubmit	public static	function	Confirms that #commerce_element_submit handlers can be run.
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
InlineFormBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
InlineFormBase::getLabel	public	function	Gets the inline form label. Overrides InlineFormInterface::getLabel
InlineFormBase::runSubmit	public static	function	Runs the inline form submission.
InlineFormBase::runValidate	public static	function	Runs the inline form validation.
InlineFormBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
InlineFormBase::updatePageTitle	public static	function	Updates the page title based on the inline form's #page_title property.
InlineFormBase::validateConfiguration	protected	function	Validates configuration.	1
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.
PluginConfiguration::$pluginManager	protected	property	The plugin manager.
PluginConfiguration::buildInlineForm	public	function	Builds the inline form. Overrides InlineFormBase::buildInlineForm
PluginConfiguration::create	public static	function	Creates an instance of the plugin. Overrides InlineFormBase::create
PluginConfiguration::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides InlineFormBase::defaultConfiguration
PluginConfiguration::requiredConfiguration	protected	function	Gets the required configuration for this plugin. Overrides InlineFormBase::requiredConfiguration
PluginConfiguration::submitInlineForm	public	function	Submits the inline form. Overrides InlineFormBase::submitInlineForm
PluginConfiguration::validateInlineForm	public	function	Validates the inline form. Overrides InlineFormBase::validateInlineForm
PluginConfiguration::__construct	public	function	Constructs a new PluginConfiguration object. Overrides InlineFormBase::__construct
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.

You are here