class ConfigurableEventHandlerEntityBundle

Exposes the bundle of an entity as event setting.

Hierarchy

Expanded class hierarchy of ConfigurableEventHandlerEntityBundle

1 string reference to 'ConfigurableEventHandlerEntityBundle'
rules.rules.events.yml in ./rules.rules.events.yml
rules.rules.events.yml

File

src/EventHandler/ConfigurableEventHandlerEntityBundle.php, line 11

Namespace

Drupal\rules\EventHandler
View source
class ConfigurableEventHandlerEntityBundle extends ConfigurableEventHandlerBase {
    
    /**
     * {@inheritdoc}
     */
    public static function determineQualifiedEvents(object $event, $event_name, array &$event_definition) {
        // @todo The 'object' type hint should be replaced with the appropriate
        // class once Symfony 4 is no longer supported.
        $events_suffixes = [];
        if ($event instanceof EntityEvent) {
            $events_suffixes[] = $event->getSubject()
                ->bundle();
        }
        return $events_suffixes;
    }
    
    /**
     * {@inheritdoc}
     */
    public function summary() {
        // Nothing to do by default.
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
        // Nothing to do by default.
    }
    
    /**
     * {@inheritdoc}
     */
    public function validate() {
        // Nothing to check by default.
    }
    
    /**
     * {@inheritdoc}
     */
    public function getEventNameSuffix() {
        // Nothing to do by default.
    }
    
    /**
     * {@inheritdoc}
     */
    public function refineContextDefinitions() {
        // Nothing to refine by default.
    }

}

Members

Title Sort descending 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
ConfigurableEventHandlerEntityBundle::buildConfigurationForm public function Builds the event configuration form. Overrides RulesConfigurableEventHandlerInterface::buildConfigurationForm
ConfigurableEventHandlerEntityBundle::determineQualifiedEvents public static function Determines the qualified event names for the dispatched event. Overrides RulesConfigurableEventHandlerInterface::determineQualifiedEvents
ConfigurableEventHandlerEntityBundle::getEventNameSuffix public function Provides the event name suffix based upon the plugin configuration. Overrides RulesConfigurableEventHandlerInterface::getEventNameSuffix
ConfigurableEventHandlerEntityBundle::refineContextDefinitions public function Refines provided context definitions based upon plugin configuration. Overrides RulesConfigurableEventHandlerInterface::refineContextDefinitions
ConfigurableEventHandlerEntityBundle::summary public function Provides a human readable summary of the event's configuration. Overrides RulesConfigurableEventHandlerInterface::summary
ConfigurableEventHandlerEntityBundle::validate public function Validates that this event is configured correctly. Overrides RulesConfigurableEventHandlerInterface::validate
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
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