abstract class ConfigurableEventHandlerBase in Rules 8.3

Base class for event handler.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\rules\Core\RulesDefaultEventHandler implements RulesEventHandlerInterface
      • class \Drupal\rules\EventHandler\ConfigurableEventHandlerBase implements RulesConfigurableEventHandlerInterface

File

src/EventHandler/ConfigurableEventHandlerBase.php, line 12

Namespace

Drupal\rules\EventHandler

abstract class ConfigurableEventHandlerBase extends RulesDefaultEventHandler implements RulesConfigurableEventHandlerInterface {

  /**
   * The event configuration.
   *
   * @var array
   */
  protected $configuration = [];

  /**
   * {@inheritdoc}
   */
  public function extractConfigurationFormValues(array &$form, FormStateInterface $form_state) {
    foreach ($this
      ->defaultConfiguration() as $key => $configuration) {
      $this->configuration[$key] = $form_state
        ->hasValue($key) ? $form_state
        ->getValue($key) : $configuration;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getConfiguration() {
    return $this->configuration;
  }

  /**
   * {@inheritdoc}
   */
  public function setConfiguration(array $configuration) {
    $this->configuration = $configuration + $this
      ->defaultConfiguration();
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurableEventHandlerBase::$configuration	protected	property	The event configuration. Overrides PluginBase::$configuration
ConfigurableEventHandlerBase::defaultConfiguration	public	function	Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
ConfigurableEventHandlerBase::extractConfigurationFormValues	public	function	Extract the form values and update the event configuration. Overrides RulesConfigurableEventHandlerInterface::extractConfigurationFormValues
ConfigurableEventHandlerBase::getConfiguration	public	function	Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ConfigurableEventHandlerBase::setConfiguration	public	function	Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
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
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
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
RulesConfigurableEventHandlerInterface::buildConfigurationForm	public	function	Builds the event configuration form.	1
RulesConfigurableEventHandlerInterface::determineQualifiedEvents	public static	function	Determines the qualified event names for the dispatched event.	1
RulesConfigurableEventHandlerInterface::getEventNameSuffix	public	function	Provides the event name suffix based upon the plugin configuration.	1
RulesConfigurableEventHandlerInterface::refineContextDefinitions	public	function	Refines provided context definitions based upon plugin configuration.	1
RulesConfigurableEventHandlerInterface::summary	public	function	Provides a human readable summary of the event's configuration.	1
RulesConfigurableEventHandlerInterface::validate	public	function	Validates that this event is configured correctly.	1
RulesDefaultEventHandler::getContextDefinition	public	function	Gets a specific context definition of the plugin. Overrides RulesEventHandlerInterface::getContextDefinition
RulesDefaultEventHandler::getContextDefinitions	public	function	Gets the context definitions of the event. Overrides RulesEventHandlerInterface::getContextDefinitions
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.