class ConfigurableEventHandlerEntityBundle in Rules 8.3

Exposes the bundle of an entity as event setting.

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
        • class \Drupal\rules\EventHandler\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 12

Namespace

Drupal\rules\EventHandler

class ConfigurableEventHandlerEntityBundle extends ConfigurableEventHandlerBase {

  /**
   * {@inheritdoc}
   */
  public static function determineQualifiedEvents(Event $event, $event_name, array &$event_definition) {
    $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

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
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
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
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.