class RulesComponentConfig in Rules 8.3
Rules component configuration entity to persistently store configuration.
Plugin annotation
@ConfigEntityType(
id = "rules_component",
label = @Translation("Rules component"),
label_collection = @Translation("Rules components"),
label_singular = @Translation("rules component"),
label_plural = @Translation("rules components"),
label_count = @PluralTranslation(
singular = "@count rules component",
plural = "@count rules components",
),
handlers = {
"list_builder" = "Drupal\rules\Controller\RulesComponentListBuilder",
"form" = {
"add" = "\Drupal\rules\Form\RulesComponentAddForm",
"edit" = "\Drupal\rules\Form\RulesComponentEditForm",
"delete" = "\Drupal\Core\Entity\EntityDeleteForm",
},
},
admin_permission = "administer rules",
config_prefix = "component",
entity_keys = {
"id" = "id",
"label" = "label",
"status" = "status",
},
config_export = {
"id",
"label",
"description",
"tags",
"config_version",
"component",
},
links = {
"collection" = "/admin/config/workflow/rules/components",
"edit-form" = "/admin/config/workflow/rules/components/edit/{rules_component}",
"delete-form" = "/admin/config/workflow/rules/components/delete/{rules_component}",
}
)
Hierarchy
- class \Drupal\Core\Entity\EntityBase implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
- class \Drupal\rules\Entity\RulesComponentConfig implements RulesUiComponentProviderInterface
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
Expanded class hierarchy of RulesComponentConfig
4 files declare their use of RulesComponentConfig
- ComponentConfigResolver.php in src/
ComponentResolver/ ComponentConfigResolver.php - CoreIntegrationTest.php in tests/
src/ Kernel/ CoreIntegrationTest.php - rules.install in ./
rules.install - Install, update and uninstall functions for the Rules module.
- RulesComponentActionTest.php in tests/
src/ Unit/ Integration/ RulesAction/ RulesComponentActionTest.php
File
- src/
Entity/ RulesComponentConfig.php, line 55
Namespace
Drupal\rules\EntityView source
class RulesComponentConfig extends ConfigEntityBase implements RulesUiComponentProviderInterface {
/**
* The unique ID of the Rules component.
*
* @var string
*/
public $id = NULL;
/**
* The label of the Rules component.
*
* @var string
*/
protected $label;
/**
* The description of the rule, which is used only in the user interface.
*
* @var string
*/
protected $description = '';
/**
* The "tags" of a Rules component.
*
* @var string[]
*/
protected $tags = [];
/**
* The config version the Rules component was created for.
*
* @var int
*/
protected $config_version = Rules::CONFIG_VERSION;
/**
* The component configuration as nested array.
*
* @var array
*
* @see \Drupal\rules\Engine\RulesComponent::getConfiguration()
*/
protected $component = [];
/**
* Stores a reference to the component object.
*
* @var \Drupal\rules\Engine\RulesComponent
*/
protected $componentObject;
/**
* Gets a Rules expression instance for this Rules component.
*
* @return \Drupal\rules\Engine\ExpressionInterface
* A Rules expression instance.
*/
public function getExpression() {
return $this
->getComponent()
->getExpression();
}
/**
* Sets a Rules expression instance for this Rules component.
*
* @param \Drupal\rules\Engine\ExpressionInterface $expression
* The expression to set.
*
* @return $this
*/
public function setExpression(ExpressionInterface $expression) {
$this->component['expression'] = $expression
->getConfiguration();
unset($this->componentObject);
return $this;
}
/**
* {@inheritdoc}
*/
public function getComponent() {
if (!isset($this->componentObject)) {
$this->componentObject = RulesComponent::createFromConfiguration($this->component);
}
return $this->componentObject;
}
/**
* {@inheritdoc}
*/
public function updateFromComponent(RulesComponent $component) {
$this->component = $component
->getConfiguration();
$this->componentObject = $component;
return $this;
}
/**
* Gets the definitions of the used context.
*
* @return \Drupal\rules\Context\ContextDefinitionInterface[]
* The array of context definition, keyed by context name.
*/
public function getContextDefinitions() {
$definitions = [];
if (!empty($this->component['context_definitions'])) {
foreach ($this->component['context_definitions'] as $name => $definition) {
$definitions[$name] = ContextDefinition::createFromArray($definition);
}
}
return $definitions;
}
/**
* Sets the definitions of the used context.
*
* @param \Drupal\rules\Context\ContextDefinitionInterface[] $definitions
* The array of context definitions, keyed by context name.
*
* @return $this
*/
public function setContextDefinitions(array $definitions) {
$this->component['context_definitions'] = [];
foreach ($definitions as $name => $definition) {
$this->component['context_definitions'][$name] = $definition
->toArray();
}
return $this;
}
/**
* Gets the definitions of the provided context.
*
* @return \Drupal\rules\Context\ContextDefinitionInterface[]
* The array of context definition, keyed by context name.
*/
public function getProvidedContextDefinitions() {
$definitions = [];
if (!empty($this->component['provided_context_definitions'])) {
foreach ($this->component['provided_context_definitions'] as $name => $definition) {
$definitions[$name] = ContextDefinition::createFromArray($definition);
}
}
return $definitions;
}
/**
* Sets the definitions of the provided context.
*
* @param \Drupal\rules\Context\ContextDefinitionInterface[] $definitions
* The array of context definitions, keyed by context name.
*
* @return $this
*/
public function setProvidedContextDefinitions(array $definitions) {
$this->component['provided_context_definitions'] = [];
foreach ($definitions as $name => $definition) {
$this->component['provided_context_definitions'][$name] = $definition
->toArray();
}
return $this;
}
/**
* {@inheritdoc}
*/
public function createDuplicate() {
$duplicate = parent::createDuplicate();
unset($duplicate->componentObject);
return $duplicate;
}
/**
* Overrides \Drupal\Core\Entity\Entity::label().
*
* When a certain component does not have a label return the ID.
*/
public function label() {
if (!($label = $this
->get('label'))) {
$label = $this
->id();
}
return $label;
}
/**
* Returns the description.
*/
public function getDescription() {
return $this->description;
}
/**
* Checks if there are tags associated with this config.
*
* @return bool
* TRUE if the config has tags.
*/
public function hasTags() {
return !empty($this->tags);
}
/**
* Returns the tags associated with this config.
*
* @return string[]
* The numerically indexed array of tag names.
*/
public function getTags() {
return $this->tags;
}
/**
* {@inheritdoc}
*/
public function calculateDependencies() {
parent::calculateDependencies();
$this
->addDependencies($this
->getComponent()
->calculateDependencies());
return $this->dependencies;
}
/**
* Magic clone method.
*/
public function __clone() {
// Remove the reference to the expression object in the clone so that the
// expression object tree is created from scratch.
unset($this->expression);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CacheableDependencyTrait:: |
protected | property | Cache contexts. | |
CacheableDependencyTrait:: |
protected | property | Cache max-age. | |
CacheableDependencyTrait:: |
protected | property | Cache tags. | |
CacheableDependencyTrait:: |
protected | function | Sets cacheability; useful for value object constructors. | |
ConfigEntityBase:: |
private | property | Whether the config is being deleted by the uninstall process. | |
ConfigEntityBase:: |
protected | property | The language code of the entity's default language. | |
ConfigEntityBase:: |
protected | property | The original ID of the configuration entity. | |
ConfigEntityBase:: |
protected | property | The enabled/disabled status of the configuration entity. | 4 |
ConfigEntityBase:: |
protected | property | Third party entity settings. | |
ConfigEntityBase:: |
protected | property | Trust supplied data and not use configuration schema on save. | |
ConfigEntityBase:: |
protected | property | The UUID for this entity. | |
ConfigEntityBase:: |
protected | property | Information maintained by Drupal core about configuration. | |
ConfigEntityBase:: |
protected | function | Overrides \Drupal\Core\Entity\DependencyTrait:addDependency(). | |
ConfigEntityBase:: |
public | function |
Disables the configuration entity. Overrides ConfigEntityInterface:: |
1 |
ConfigEntityBase:: |
public | function |
Enables the configuration entity. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Returns the value of a property. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Returns the cache tags that should be used to invalidate caches. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Gets the configuration dependency name. Overrides EntityBase:: |
|
ConfigEntityBase:: |
protected static | function | Gets the configuration manager. | |
ConfigEntityBase:: |
public | function |
Gets the configuration target identifier for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the configuration dependencies. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the original ID. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
protected | function | Gets the typed config manager. | |
ConfigEntityBase:: |
public | function |
Gets whether on not the data is trusted. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
protected static | function |
Override to never invalidate the individual entities' cache tags; the
config system already invalidates them. Overrides EntityBase:: |
|
ConfigEntityBase:: |
protected | function |
Override to never invalidate the entity's cache tag; the config system
already invalidates it. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Checks whether this entity is installable. Overrides ConfigEntityInterface:: |
2 |
ConfigEntityBase:: |
public | function |
Overrides Entity::isNew(). Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Deprecated way of generating a link to the entity. See toLink(). Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface:: |
7 |
ConfigEntityBase:: |
public static | function |
Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase:: |
8 |
ConfigEntityBase:: |
public | function |
Acts on an entity before the presave hook is invoked. Overrides EntityBase:: |
13 |
ConfigEntityBase:: |
public | function |
Saves an entity permanently. Overrides EntityBase:: |
1 |
ConfigEntityBase:: |
public | function |
Sets the value of a property. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Sets the original ID. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Sets the status of the configuration entity. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function | ||
ConfigEntityBase:: |
public static | function | Helper callback for uasort() to sort configuration entities by weight and label. | 6 |
ConfigEntityBase:: |
public | function |
Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface:: |
4 |
ConfigEntityBase:: |
public | function |
Gets an array of all property values. Overrides EntityBase:: |
2 |
ConfigEntityBase:: |
public | function |
Gets the URL object for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Sets that the data should be trusted. Overrides ConfigEntityInterface:: |
|
ConfigEntityBase:: |
public | function |
Unsets a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
ConfigEntityBase:: |
public | function |
Gets the public URL for this entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Gets the URL object for the entity. Overrides EntityBase:: |
|
ConfigEntityBase:: |
public | function |
Constructs an Entity object. Overrides EntityBase:: |
10 |
ConfigEntityBase:: |
public | function |
Overrides EntityBase:: |
4 |
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 | Aliased as: traitSleep | 1 |
DependencySerializationTrait:: |
public | function | 2 | |
DependencyTrait:: |
protected | property | The object's dependencies. | |
DependencyTrait:: |
protected | function | Adds multiple dependencies. | |
DependencyTrait:: |
protected | function | Adds a dependency. Aliased as: addDependencyTrait | |
EntityBase:: |
protected | property | Boolean indicating whether the entity should be forced to be new. | |
EntityBase:: |
protected | property | The entity type. | |
EntityBase:: |
protected | property | A typed data object wrapping this entity. | |
EntityBase:: |
public | function |
Checks data value access. Overrides AccessibleInterface:: |
1 |
EntityBase:: |
public | function |
Gets the bundle of the entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
public static | function |
Constructs a new entity object, without permanently saving it. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Deletes an entity permanently. Overrides EntityInterface:: |
2 |
EntityBase:: |
public | function |
Enforces an entity to be new. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | Gets the entity manager. | |
EntityBase:: |
protected | function | Gets the entity type bundle info service. | |
EntityBase:: |
protected | function | Gets the entity type manager. | |
EntityBase:: |
public | function |
The cache contexts associated with this object. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
The maximum age for which this object may be cached. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
The cache tags associated with this object. Overrides CacheableDependencyTrait:: |
|
EntityBase:: |
public | function |
Gets the key that is used to store configuration dependencies. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the entity type definition. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the ID of the type of the entity. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | The list cache tags to invalidate for this entity. | |
EntityBase:: |
public | function |
Gets a typed data object for this entity object. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Indicates if a link template exists for a given key. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets the identifier. Overrides EntityInterface:: |
11 |
EntityBase:: |
public | function |
Gets the language of the entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
protected | function | Gets the language manager. | |
EntityBase:: |
protected | function | Gets an array link templates. | 1 |
EntityBase:: |
public static | function |
Loads an entity. Overrides EntityInterface:: |
|
EntityBase:: |
public static | function |
Loads one or more entities. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Acts on a created entity before hooks are invoked. Overrides EntityInterface:: |
4 |
EntityBase:: |
public static | function |
Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface:: |
16 |
EntityBase:: |
public static | function |
Acts on loaded entities. Overrides EntityInterface:: |
2 |
EntityBase:: |
public | function |
Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface:: |
14 |
EntityBase:: |
public static | function |
Changes the values of an entity before it is created. Overrides EntityInterface:: |
5 |
EntityBase:: |
public | function |
Gets a list of entities referenced by this entity. Overrides EntityInterface:: |
1 |
EntityBase:: |
public | function |
Generates the HTML for a link to this entity. Overrides EntityInterface:: |
|
EntityBase:: |
public | function |
Gets a list of URI relationships supported by this entity. Overrides EntityInterface:: |
|
EntityBase:: |
protected | function | Gets an array of placeholders for this entity. | 2 |
EntityBase:: |
public | function |
Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface:: |
1 |
EntityBase:: |
protected | function | Gets the UUID generator. | |
PluginDependencyTrait:: |
protected | function | Calculates and adds dependencies of a specific plugin instance. | 1 |
PluginDependencyTrait:: |
protected | function | Calculates and returns dependencies of a specific plugin instance. | |
PluginDependencyTrait:: |
protected | function | Wraps the module handler. | 1 |
PluginDependencyTrait:: |
protected | function | Wraps the theme handler. | 1 |
RefinableCacheableDependencyTrait:: |
public | function | 1 | |
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
RulesComponentConfig:: |
protected | property | The component configuration as nested array. | |
RulesComponentConfig:: |
protected | property | Stores a reference to the component object. | |
RulesComponentConfig:: |
protected | property | The config version the Rules component was created for. | |
RulesComponentConfig:: |
protected | property | The description of the rule, which is used only in the user interface. | |
RulesComponentConfig:: |
public | property | The unique ID of the Rules component. | |
RulesComponentConfig:: |
protected | property | The label of the Rules component. | |
RulesComponentConfig:: |
protected | property | The "tags" of a Rules component. | |
RulesComponentConfig:: |
public | function |
Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityBase:: |
|
RulesComponentConfig:: |
public | function |
Creates a duplicate of the entity. Overrides ConfigEntityBase:: |
|
RulesComponentConfig:: |
public | function |
Gets the Rules component to be edited. Overrides RulesUiComponentProviderInterface:: |
|
RulesComponentConfig:: |
public | function | Gets the definitions of the used context. | |
RulesComponentConfig:: |
public | function | Returns the description. | |
RulesComponentConfig:: |
public | function | Gets a Rules expression instance for this Rules component. | |
RulesComponentConfig:: |
public | function | Gets the definitions of the provided context. | |
RulesComponentConfig:: |
public | function | Returns the tags associated with this config. | |
RulesComponentConfig:: |
public | function | Checks if there are tags associated with this config. | |
RulesComponentConfig:: |
public | function |
Overrides \Drupal\Core\Entity\Entity::label(). Overrides EntityBase:: |
|
RulesComponentConfig:: |
public | function | Sets the definitions of the used context. | |
RulesComponentConfig:: |
public | function | Sets a Rules expression instance for this Rules component. | |
RulesComponentConfig:: |
public | function | Sets the definitions of the provided context. | |
RulesComponentConfig:: |
public | function |
Updates the configuration based upon the given component. Overrides RulesUiComponentProviderInterface:: |
|
RulesComponentConfig:: |
public | function | Magic clone method. | |
SynchronizableEntityTrait:: |
protected | property | Whether this entity is being created, updated or deleted through a synchronization process. | |
SynchronizableEntityTrait:: |
public | function | ||
SynchronizableEntityTrait:: |
public | function |