abstract class ActionExpressionContainer in Rules 8.3
Container for actions.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\rules\Engine\ExpressionBase implements ExpressionInterface
- class \Drupal\rules\Engine\ExpressionContainerBase implements ExpressionContainerInterface
- class \Drupal\rules\Engine\ActionExpressionContainer implements ContainerFactoryPluginInterface, ActionExpressionContainerInterface
- class \Drupal\rules\Engine\ExpressionContainerBase implements ExpressionContainerInterface
- class \Drupal\rules\Engine\ExpressionBase implements ExpressionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of ActionExpressionContainer
2 files declare their use of ActionExpressionContainer
- ActionSetExpression.php in src/
Plugin/ RulesExpression/ ActionSetExpression.php - LoopExpression.php in src/
Plugin/ RulesExpression/ LoopExpression.php
File
- src/
Engine/ ActionExpressionContainer.php, line 13
Namespace
Drupal\rules\EngineView source
abstract class ActionExpressionContainer extends ExpressionContainerBase implements ActionExpressionContainerInterface, ContainerFactoryPluginInterface {
/**
* List of actions that will be executed.
*
* @var \Drupal\rules\Engine\ActionExpressionInterface[]
*/
protected $actions = [];
/**
* Constructor.
*
* @param array $configuration
* A configuration array containing information about the plugin instance.
* @param string $plugin_id
* The plugin_id for the plugin instance.
* @param array $plugin_definition
* The plugin implementation definition.
* @param \Drupal\rules\Engine\ExpressionManagerInterface $expression_manager
* The rules expression plugin manager.
* @param \Drupal\Core\Logger\LoggerChannelInterface $logger
* The Rules debug logger channel.
*/
public function __construct(array $configuration, $plugin_id, array $plugin_definition, ExpressionManagerInterface $expression_manager, LoggerChannelInterface $logger) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->expressionManager = $expression_manager;
$this->rulesDebugLogger = $logger;
$configuration += [
'actions' => [],
];
foreach ($configuration['actions'] as $action_config) {
$action = $expression_manager
->createInstance($action_config['id'], $action_config);
$this->actions[] = $action;
}
}
/**
* {@inheritdoc}
*/
public function addExpressionObject(ExpressionInterface $expression) {
if (!$expression instanceof ActionExpressionInterface) {
throw new InvalidExpressionException('Only action expressions can be added to an action container.');
}
$uuid = $expression
->getUuid();
if ($this
->getExpression($uuid)) {
throw new InvalidExpressionException("An action with UUID {$uuid} already exists in the container.");
}
$this->actions[] = $expression;
return $this;
}
/**
* {@inheritdoc}
*/
public function addAction($action_id, ContextConfig $config = NULL) {
return $this
->addExpressionObject($this->expressionManager
->createAction($action_id)
->setConfiguration($config ? $config
->toArray() : []));
}
/**
* {@inheritdoc}
*/
public function getConfiguration() {
$configuration = parent::getConfiguration();
// We need to update the configuration in case actions have been added or
// changed.
$configuration['actions'] = [];
// Use the iterator, which sorts the actions by weight.
foreach ($this as $action) {
$configuration['actions'][] = $action
->getConfiguration();
}
return $configuration;
}
/**
* {@inheritdoc}
*/
public function getIterator() {
$iterator = new \ArrayIterator($this->actions);
$iterator
->uasort([
ExpressionContainerBase::class,
'sortByWeightProperty',
]);
return $iterator;
}
/**
* PHP magic __clone function.
*/
public function __clone() {
// Implement a deep clone.
foreach ($this->actions as &$action) {
$action = clone $action;
}
}
/**
* {@inheritdoc}
*/
public function getExpression($uuid) {
foreach ($this->actions as $action) {
if ($action
->getUuid() === $uuid) {
return $action;
}
if ($action instanceof ExpressionContainerInterface) {
$nested_action = $action
->getExpression($uuid);
if ($nested_action) {
return $nested_action;
}
}
}
return FALSE;
}
/**
* {@inheritdoc}
*/
public function deleteExpression($uuid) {
foreach ($this->actions as $index => $action) {
if ($action
->getUuid() === $uuid) {
unset($this->actions[$index]);
return TRUE;
}
if ($action instanceof ExpressionContainerInterface && $action
->deleteExpression($uuid)) {
return TRUE;
}
}
return FALSE;
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ActionExpressionContainer:: |
protected | property | List of actions that will be executed. | |
ActionExpressionContainer:: |
public | function |
Creates an action expression and adds it to the container. Overrides ActionExpressionContainerInterface:: |
|
ActionExpressionContainer:: |
public | function |
Adds an expression object. Overrides ExpressionContainerInterface:: |
|
ActionExpressionContainer:: |
public | function |
Deletes an expression identified by the specified UUID in the container. Overrides ExpressionContainerInterface:: |
|
ActionExpressionContainer:: |
public | function |
Gets this plugin's configuration. Overrides ExpressionBase:: |
|
ActionExpressionContainer:: |
public | function |
Looks up the expression by UUID in this container. Overrides ExpressionContainerInterface:: |
|
ActionExpressionContainer:: |
public | function | ||
ActionExpressionContainer:: |
public | function | PHP magic __clone function. | |
ActionExpressionContainer:: |
public | function |
Constructor. Overrides ExpressionBase:: |
|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
ExpressionBase:: |
protected | property | The config entity this expression is associated with, if any. | |
ExpressionBase:: |
protected | property |
The plugin configuration. Overrides PluginBase:: |
|
ExpressionBase:: |
protected | property | The root expression if this object is nested. | |
ExpressionBase:: |
protected | property | The UUID of this expression. | |
ExpressionBase:: |
protected | property | The weight (list order) of this expression. | |
ExpressionBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
|
ExpressionBase:: |
public | function |
Gets default configuration for this plugin. Overrides ConfigurableInterface:: |
2 |
ExpressionBase:: |
public | function |
Executes a rules expression. Overrides ExecutableInterface:: |
|
ExpressionBase:: |
public | function |
Returns the form handling class for this expression. Overrides ExpressionInterface:: |
2 |
ExpressionBase:: |
public | function |
The label of this expression element that can be shown in the UI. Overrides ExpressionInterface:: |
2 |
ExpressionBase:: |
public | function |
Returns the root expression if this expression is nested. Overrides ExpressionInterface:: |
|
ExpressionBase:: |
public | function |
Returns the UUID of this expression if it is nested in another expression. Overrides ExpressionInterface:: |
|
ExpressionBase:: |
public | function |
Returns the list order of this expression. Overrides ExpressionInterface:: |
|
ExpressionBase:: |
public | function |
Sets the configuration for this plugin instance. Overrides ConfigurableInterface:: |
2 |
ExpressionBase:: |
public | function |
Set the root expression for this expression if it is nested. Overrides ExpressionInterface:: |
|
ExpressionBase:: |
public | function |
Sets the UUID of this expression in an expression tree. Overrides ExpressionInterface:: |
|
ExpressionBase:: |
public | function |
Sets the list order of this expression in an expression tree. Overrides ExpressionInterface:: |
|
ExpressionContainerBase:: |
protected | property | The expression manager. | |
ExpressionContainerBase:: |
protected | property | The rules debug logger channel. | |
ExpressionContainerBase:: |
public | function |
Creates and adds an expression. Overrides ExpressionContainerInterface:: |
|
ExpressionContainerBase:: |
abstract protected | function | Determines whether child-expressions are allowed to assert metadata. | 4 |
ExpressionContainerBase:: |
public | function |
Verifies that this expression is configured correctly. Overrides ExpressionInterface:: |
1 |
ExpressionContainerBase:: |
public static | function | ||
ExpressionContainerBase:: |
public | function |
Prepares the execution metadata state by adding metadata to it. Overrides ExpressionInterface:: |
|
ExpressionContainerBase:: |
protected | function | Prepares execution metadata state after traversing through children. | 1 |
ExpressionContainerBase:: |
protected | function | Prepares execution metadata state before traversing through children. | 1 |
ExpressionContainerBase:: |
public static | function | Sorts an array of expressions by 'weight' property. | |
ExpressionInterface:: |
public | function | Execute the expression with a given Rules state. | 6 |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |