class RulesComponentConfig

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

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\Entity
View 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

Title Sort descending Modifiers Object type Summary Member alias Overriden Title Overrides
CacheableDependencyTrait::$cacheContexts protected property Cache contexts.
CacheableDependencyTrait::$cacheMaxAge protected property Cache max-age.
CacheableDependencyTrait::$cacheTags protected property Cache tags.
CacheableDependencyTrait::setCacheability protected function Sets cacheability; useful for value object constructors.
ConfigEntityBase::$isUninstalling private property Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode protected property The language code of the entity's default language.
ConfigEntityBase::$originalId protected property The original ID of the configuration entity.
ConfigEntityBase::$status protected property The enabled/disabled status of the configuration entity. 4
ConfigEntityBase::$third_party_settings protected property Third party entity settings.
ConfigEntityBase::$trustedData protected property Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid protected property The UUID for this entity.
ConfigEntityBase::$_core protected property
ConfigEntityBase::addDependency protected function Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::disable public function Disables the configuration entity. Overrides ConfigEntityInterface::disable 1
ConfigEntityBase::enable public function Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get public function Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides EntityBase::getCacheTagsToInvalidate 1
ConfigEntityBase::getConfigDependencyName public function Gets the configuration dependency name. Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager protected static function Gets the configuration manager.
ConfigEntityBase::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies public function Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId public function Gets the original ID. Overrides EntityBase::getOriginalId
ConfigEntityBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig protected function Gets the typed config manager.
ConfigEntityBase::hasTrustedData public function Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete protected static function Override to never invalidate the individual entities' cache tags; the
config system already invalidates them.
Overrides EntityBase::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave protected function Override to never invalidate the entity's cache tag; the config system
already invalidates it.
Overrides EntityBase::invalidateTagsOnSave
ConfigEntityBase::isInstallable public function Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable 2
ConfigEntityBase::isNew public function Overrides Entity::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling public function Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval 8
ConfigEntityBase::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete 8
ConfigEntityBase::preSave public function Acts on an entity before the presave hook is invoked. Overrides EntityBase::preSave 13
ConfigEntityBase::save public function Saves an entity permanently. Overrides EntityBase::save 1
ConfigEntityBase::set public function Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId public function Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus public function Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling public function
ConfigEntityBase::sort public static function Helper callback for uasort() to sort configuration entities by weight and label. 6
ConfigEntityBase::status public function Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status 4
ConfigEntityBase::toArray public function Gets an array of all property values. Overrides EntityBase::toArray 2
ConfigEntityBase::toUrl public function Gets the URL object for the entity. Overrides EntityBase::toUrl
ConfigEntityBase::trustData public function Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::__construct public function Constructs an Entity object. Overrides EntityBase::__construct 10
ConfigEntityBase::__sleep public function Overrides EntityBase::__sleep 4
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function Aliased as: traitSleep 1
DependencySerializationTrait::__wakeup public function 2
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency. Aliased as: addDependencyTrait
EntityBase::$enforceIsNew protected property Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId protected property The entity type.
EntityBase::$typedData protected property A typed data object wrapping this entity.
EntityBase::access public function Checks data value access. Overrides AccessibleInterface::access 1
EntityBase::bundle public function Gets the bundle of the entity. Overrides EntityInterface::bundle 1
EntityBase::create public static function Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create 1
EntityBase::delete public function Deletes an entity permanently. Overrides EntityInterface::delete 1
EntityBase::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityTypeBundleInfo protected function Gets the entity type bundle info service.
EntityBase::entityTypeManager protected function Gets the entity type manager.
EntityBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getEntityType public function Gets the entity type definition. Overrides EntityInterface::getEntityType
EntityBase::getEntityTypeId public function Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate protected function The list cache tags to invalidate for this entity.
EntityBase::getTypedData public function Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::getTypedDataClass private function Returns the typed data class name for this entity.
EntityBase::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::id public function Gets the identifier. Overrides EntityInterface::id 11
EntityBase::language public function Gets the language of the entity. Overrides EntityInterface::language 1
EntityBase::languageManager protected function Gets the language manager.
EntityBase::linkTemplates protected function Gets an array link templates. 1
EntityBase::load public static function Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple public static function Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate 4
EntityBase::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete 19
EntityBase::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 3
EntityBase::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave 14
EntityBase::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate 7
EntityBase::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities 1
EntityBase::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::urlRouteParameters protected function Gets an array of placeholders for this entity. 2
EntityBase::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid 1
EntityBase::uuidGenerator protected function Gets the UUID generator.
PluginDependencyTrait::calculatePluginDependencies protected function Calculates and adds dependencies of a specific plugin instance. 1
PluginDependencyTrait::getPluginDependencies protected function Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler protected function Wraps the module handler. 1
PluginDependencyTrait::themeHandler protected function Wraps the theme handler. 1
RefinableCacheableDependencyTrait::addCacheableDependency public function 1
RefinableCacheableDependencyTrait::addCacheContexts public function
RefinableCacheableDependencyTrait::addCacheTags public function
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function
RulesComponentConfig::$component protected property The component configuration as nested array.
RulesComponentConfig::$componentObject protected property Stores a reference to the component object.
RulesComponentConfig::$config_version protected property The config version the Rules component was created for.
RulesComponentConfig::$description protected property The description of the rule, which is used only in the user interface.
RulesComponentConfig::$id public property The unique ID of the Rules component.
RulesComponentConfig::$label protected property The label of the Rules component.
RulesComponentConfig::$tags protected property The "tags" of a Rules component.
RulesComponentConfig::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityBase::calculateDependencies
RulesComponentConfig::createDuplicate public function Creates a duplicate of the entity. Overrides ConfigEntityBase::createDuplicate
RulesComponentConfig::getComponent public function Gets the Rules component to be edited. Overrides RulesUiComponentProviderInterface::getComponent
RulesComponentConfig::getContextDefinitions public function Gets the definitions of the used context.
RulesComponentConfig::getDescription public function Returns the description.
RulesComponentConfig::getExpression public function Gets a Rules expression instance for this Rules component.
RulesComponentConfig::getProvidedContextDefinitions public function Gets the definitions of the provided context.
RulesComponentConfig::getTags public function Returns the tags associated with this config.
RulesComponentConfig::hasTags public function Checks if there are tags associated with this config.
RulesComponentConfig::label public function Overrides \Drupal\Core\Entity\Entity::label(). Overrides EntityBase::label
RulesComponentConfig::setContextDefinitions public function Sets the definitions of the used context.
RulesComponentConfig::setExpression public function Sets a Rules expression instance for this Rules component.
RulesComponentConfig::setProvidedContextDefinitions public function Sets the definitions of the provided context.
RulesComponentConfig::updateFromComponent public function Updates the configuration based upon the given component. Overrides RulesUiComponentProviderInterface::updateFromComponent
RulesComponentConfig::__clone public function Magic clone method.
SynchronizableEntityTrait::$isSyncing protected property Is entity being created updated or deleted through synchronization process.
SynchronizableEntityTrait::isSyncing public function
SynchronizableEntityTrait::setSyncing public function