class ConfigurableEventHandlerBase

Base class for event handler.

Hierarchy

Expanded class hierarchy of ConfigurableEventHandlerBase

File

src/EventHandler/ConfigurableEventHandlerBase.php, line 12

Namespace

Drupal\rules\EventHandler
View source 
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

Title Modifiers Object type Summary Overriden Title Overrides
ConfigurableEventHandlerBase::$configuration protected property The event 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
DerivativeInspectionInterface::getBaseId public function Gets the base_plugin_id of the plugin instance. 1
DerivativeInspectionInterface::getDerivativeId public function Gets the derivative_id of the plugin instance. 1
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
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