class RulesComponentAction

Provides a generic 'Execute Rules component' action.

@todo Add access callback information from Drupal 7.

Plugin annotation


@RulesAction(
  id = "rules_component",
  deriver = "Drupal\rules\Plugin\RulesAction\RulesComponentActionDeriver"
)

Hierarchy

Expanded class hierarchy of RulesComponentAction

File

src/Plugin/RulesAction/RulesComponentAction.php, line 20

Namespace

Drupal\rules\Plugin\RulesAction
View source
class RulesComponentAction extends RulesActionBase implements ContainerFactoryPluginInterface {
    
    /**
     * The storage of rules components.
     *
     * @var \Drupal\Core\Entity\EntityStorageInterface
     */
    protected $storage;
    
    /**
     * The ID of the rules component config entity.
     *
     * @var string
     */
    protected $componentId;
    
    /**
     * List of context names that should be saved later.
     *
     * @var string[]
     */
    protected $saveLater = [];
    
    /**
     * Constructs a RulesComponentAction 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\Core\Entity\EntityStorageInterface $storage
     *   The entity storage service.
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityStorageInterface $storage) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->storage = $storage;
        $this->componentId = $plugin_definition['component_id'];
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
        return new static($configuration, $plugin_id, $plugin_definition, $container->get('entity_type.manager')
            ->getStorage('rules_component'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function execute() {
        $rules_config = $this->storage
            ->load($this->componentId);
        // Setup an isolated execution state for this expression and pass on the
        // necessary context.
        $rules_component = $rules_config->getComponent();
        foreach ($this->getContexts() as $context_name => $context) {
            // Pass through the already existing typed data objects to avoid creating
            // them from scratch.
            $rules_component->getState()
                ->setVariableData($context_name, $context->getContextData());
        }
        // We don't use RulesComponent::execute() here since we don't want to
        // auto-save immediately.
        $state = $rules_component->getState();
        $expression = $rules_component->getExpression();
        $expression->executeWithState($state);
        // Postpone auto-saving to the parent expression triggering this action.
        foreach ($state->getAutoSaveSelectors() as $selector) {
            $parts = explode('.', $selector);
            $context_name = reset($parts);
            if (array_key_exists($context_name, $this->context)) {
                $this->saveLater[] = $context_name;
            }
            else {
                // Otherwise we need to save here since it will not happen in the parent
                // execution.
                $typed_data = $state->fetchDataByPropertyPath($selector);
                // Things that can be saved must have a save() method, right?
                // Saving is always done at the root of the typed data tree, for example
                // on the entity level.
                $typed_data->getRoot()
                    ->getValue()
                    ->save();
            }
        }
        foreach ($this->getProvidedContextDefinitions() as $name => $definition) {
            $this->setProvidedValue($name, $state->getVariable($name));
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function autoSaveContext() {
        return $this->saveLater;
    }

}

Members

Title Sort descending Modifiers Object type Summary Member alias Overriden Title Overrides
ConfigurationAccessControlTrait::checkConfigurationAccess public function Checks configuration permission.
ContextAwarePluginTrait::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginTrait::$initializedContextConfig protected property Tracks whether the context has been initialized from configuration.
ContextAwarePluginTrait::getCacheContexts public function 9
ContextAwarePluginTrait::getCacheMaxAge public function 7
ContextAwarePluginTrait::getCacheTags public function 4
ContextAwarePluginTrait::getContext public function
ContextAwarePluginTrait::getContextDefinition public function
ContextAwarePluginTrait::getContextDefinitions public function
ContextAwarePluginTrait::getContextMapping public function
ContextAwarePluginTrait::getContexts public function
ContextAwarePluginTrait::getContextValue public function Aliased as: traitGetContextValue
ContextAwarePluginTrait::getContextValues public function
ContextAwarePluginTrait::getPluginDefinition abstract public function 1
ContextAwarePluginTrait::setContext public function 1
ContextAwarePluginTrait::setContextMapping public function
ContextAwarePluginTrait::setContextValue public function
ContextAwarePluginTrait::validateContexts public function
ContextProviderTrait::$providedContext protected property The data objects that are provided by this plugin.
ContextProviderTrait::getProvidedContext public function
ContextProviderTrait::getProvidedContextDefinition public function
ContextProviderTrait::getProvidedContextDefinitions public function
ContextProviderTrait::setProvidedValue public function
ContextProviderTrait::upcastEntityId public function Upcasts an entity id to a full entity object.
ExecutablePluginTrait::getLabelValue protected function Get the translated label from the plugin definition.
ExecutablePluginTrait::summary public function Get the translated summary from the label annotation. 4
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
RulesActionBase::$configuration protected property The plugin configuration.
RulesActionBase::access public function Checks object access. Overrides RulesActionInterface::access
RulesActionBase::assertMetadata public function Asserts additional metadata for the selected data. Overrides ContextAwarePluginInterface::assertMetadata
RulesActionBase::calculateDependencies public function @todo this documentation is not actually inherited from any interface.
Do we need this empty implementation?
RulesActionBase::defaultConfiguration public function @todo this documentation is not actually inherited from any interface.
Do we need this empty implementation?
RulesActionBase::executeMultiple public function @todo this documentation is not actually inherited from any interface.
Do we need this empty implementation?
RulesActionBase::getConfiguration public function @todo this documentation is not actually inherited from any interface.
RulesActionBase::getContextValue public function Gets the value for a defined context. Overrides ContextAwarePluginInterface::getContextValue
RulesActionBase::refineContextDefinitions public function Refines used and provided context definitions based upon context values. Overrides ContextAwarePluginInterface::refineContextDefinitions 5
RulesActionBase::setConfiguration public function @todo this documentation is not actually inherited from any interface.
RulesComponentAction::$componentId protected property The ID of the rules component config entity.
RulesComponentAction::$saveLater protected property List of context names that should be saved later.
RulesComponentAction::$storage protected property The storage of rules components.
RulesComponentAction::autoSaveContext public function Returns a list of context names that should be auto-saved after execution. Overrides RulesActionBase::autoSaveContext
RulesComponentAction::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
RulesComponentAction::execute public function Executes the plugin. Overrides RulesActionBase::execute
RulesComponentAction::__construct public function Constructs a RulesComponentAction object.