class ExpressionManager in Rules 8.3

Plugin manager for all Rules expressions.

View source

class ExpressionManager extends DefaultPluginManager implements ExpressionManagerInterface {

  /**
   * The UUID generating service.
   *
   * @var \Drupal\Component\Uuid\UuidInterface
   */
  protected $uuidService;

  /**
   * Constructor.
   */
  public function __construct(\Traversable $namespaces, ModuleHandlerInterface $module_handler, UuidInterface $uuid_service, $plugin_definition_annotation_name = RulesExpression::class) {
    $this
      ->alterInfo('rules_expression');
    parent::__construct('Plugin/RulesExpression', $namespaces, $module_handler, ExpressionInterface::class, $plugin_definition_annotation_name);
    $this->uuidService = $uuid_service;
  }

  /**
   * {@inheritdoc}
   */
  public function createInstance($plugin_id, array $configuration = []) {
    $instance = parent::createInstance($plugin_id, $configuration);

    // Make sure that the instance has a UUID and generate one if necessary.
    if (!$instance
      ->getUuid()) {
      $instance
        ->setUuid($this->uuidService
        ->generate());
    }
    return $instance;
  }

  /**
   * {@inheritdoc}
   */
  public function createRule(ContextConfig $configuration = NULL) {
    $config_array = is_null($configuration) ? [] : $configuration
      ->toArray();
    return $this
      ->createInstance('rules_rule', $config_array);
  }

  /**
   * {@inheritdoc}
   */
  public function createActionSet(ContextConfig $configuration = NULL) {
    $config_array = is_null($configuration) ? [] : $configuration
      ->toArray();
    return $this
      ->createInstance('rules_action_set', $config_array);
  }

  /**
   * {@inheritdoc}
   */
  public function createAction($id, ContextConfig $configuration = NULL) {
    $config_array = is_null($configuration) ? [] : $configuration
      ->toArray();
    return $this
      ->createInstance('rules_action', [
      'action_id' => $id,
    ] + $config_array);
  }

  /**
   * {@inheritdoc}
   */
  public function createCondition($id, ContextConfig $configuration = NULL) {
    $config_array = is_null($configuration) ? [] : $configuration
      ->toArray();
    return $this
      ->createInstance('rules_condition', [
      'condition_id' => $id,
    ] + $config_array);
  }

  /**
   * {@inheritdoc}
   */
  public function createAnd() {
    return $this
      ->createInstance('rules_and');
  }

  /**
   * {@inheritdoc}
   */
  public function createOr() {
    return $this
      ->createInstance('rules_or');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DefaultPluginManager::$additionalAnnotationNamespaces	protected	property	Additional namespaces the annotation discovery mechanism should scan for annotation definitions.
DefaultPluginManager::$alterHook	protected	property	Name of the alter hook if one should be invoked.
DefaultPluginManager::$cacheKey	protected	property	The cache key.
DefaultPluginManager::$cacheTags	protected	property	An array of cache tags to use for the cached definitions.
DefaultPluginManager::$defaults	protected	property	A set of defaults to be referenced by $this->processDefinition() if additional processing of plugins is necessary or helpful for development purposes.	9
DefaultPluginManager::$moduleHandler	protected	property	The module handler to invoke the alter hook.	1
DefaultPluginManager::$namespaces	protected	property	An object that implements \Traversable which contains the root paths keyed by the corresponding namespace to look for plugin implementations.
DefaultPluginManager::$pluginDefinitionAnnotationName	protected	property	The name of the annotation that contains the plugin definition.
DefaultPluginManager::$pluginInterface	protected	property	The interface each plugin should implement.	1
DefaultPluginManager::$subdir	protected	property	The subdirectory within a namespace to look for plugins, or FALSE if the plugins are in the top level of the namespace.
DefaultPluginManager::alterDefinitions	protected	function	Invokes the hook to alter the definitions if the alter hook is set.	1
DefaultPluginManager::alterInfo	protected	function	Sets the alter hook name.
DefaultPluginManager::clearCachedDefinitions	public	function	Clears static and persistent plugin definition caches. Overrides CachedDiscoveryInterface::clearCachedDefinitions	5
DefaultPluginManager::extractProviderFromDefinition	protected	function	Extracts the provider from a plugin definition.
DefaultPluginManager::findDefinitions	protected	function	Finds plugin definitions.	7
DefaultPluginManager::fixContextAwareDefinitions	private	function	Fix the definitions of context-aware plugins.
DefaultPluginManager::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
DefaultPluginManager::getCachedDefinitions	protected	function	Returns the cached plugin definitions of the decorated discovery class.
DefaultPluginManager::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
DefaultPluginManager::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags
DefaultPluginManager::getDefinitions	public	function	Gets the definition of all plugins for this type. Overrides DiscoveryTrait::getDefinitions	2
DefaultPluginManager::getDiscovery	protected	function	Gets the plugin discovery. Overrides PluginManagerBase::getDiscovery	12
DefaultPluginManager::getFactory	protected	function	Gets the plugin factory. Overrides PluginManagerBase::getFactory
DefaultPluginManager::processDefinition	public	function	Performs extra processing on plugin definitions.	13
DefaultPluginManager::providerExists	protected	function	Determines if the provider of a definition exists.	3
DefaultPluginManager::setCacheBackend	public	function	Initialize the cache backend.
DefaultPluginManager::setCachedDefinitions	protected	function	Sets a cache of plugin definitions for the decorated discovery class.
DefaultPluginManager::useCaches	public	function	Disable the use of caches. Overrides CachedDiscoveryInterface::useCaches	1
DiscoveryCachedTrait::$definitions	protected	property	Cached definitions array.	1
DiscoveryCachedTrait::getDefinition	public	function	Overrides DiscoveryTrait::getDefinition	3
DiscoveryTrait::doGetDefinition	protected	function	Gets a specific plugin definition.
DiscoveryTrait::hasDefinition	public	function
ExpressionManager::$uuidService	protected	property	The UUID generating service.
ExpressionManager::createAction	public	function	Creates a new action expression. Overrides ExpressionManagerInterface::createAction
ExpressionManager::createActionSet	public	function	Creates a new action set. Overrides ExpressionManagerInterface::createActionSet
ExpressionManager::createAnd	public	function	Creates a new 'and' condition container. Overrides ExpressionManagerInterface::createAnd
ExpressionManager::createCondition	public	function	Creates a new condition expression. Overrides ExpressionManagerInterface::createCondition
ExpressionManager::createInstance	public	function	Creates a pre-configured instance of a plugin. Overrides PluginManagerBase::createInstance
ExpressionManager::createOr	public	function	Creates a new 'or' condition container. Overrides ExpressionManagerInterface::createOr
ExpressionManager::createRule	public	function	Creates a new rule. Overrides ExpressionManagerInterface::createRule
ExpressionManager::__construct	public	function	Constructor. Overrides DefaultPluginManager::__construct
PluginManagerBase::$discovery	protected	property	The object that discovers plugins managed by this manager.
PluginManagerBase::$factory	protected	property	The object that instantiates plugins managed by this manager.
PluginManagerBase::$mapper	protected	property	The object that returns the preconfigured plugin instance appropriate for a particular runtime condition.
PluginManagerBase::getInstance	public	function	Gets a preconfigured instance of a plugin. Overrides MapperInterface::getInstance	7
PluginManagerBase::handlePluginNotFound	protected	function	Allows plugin managers to specify custom behavior if a plugin is not found.	1
UseCacheBackendTrait::$cacheBackend	protected	property	Cache backend instance.
UseCacheBackendTrait::$useCaches	protected	property	Flag whether caches should be used or skipped.
UseCacheBackendTrait::cacheGet	protected	function	Fetches from the cache backend, respecting the use caches flag.	1
UseCacheBackendTrait::cacheSet	protected	function	Stores data in the persistent cache, respecting the use caches flag.

You are here

class ExpressionManager in Rules 8.3

Hierarchy

See also

File

Namespace

Members

API Navigation