class RulesConditionBase

Base class for rules conditions.

@todo Figure out whether buildConfigurationForm() is useful to Rules somehow.

Hierarchy

Expanded class hierarchy of RulesConditionBase

23 files declare their use of RulesConditionBase
DataComparison.php in src/Plugin/Condition/DataComparison.php
DataIsEmpty.php in src/Plugin/Condition/DataIsEmpty.php
DataListContains.php in src/Plugin/Condition/DataListContains.php
DataListCountIs.php in src/Plugin/Condition/DataListCountIs.php
EntityHasField.php in src/Plugin/Condition/EntityHasField.php

... See full list

File

src/Core/RulesConditionBase.php, line 14

Namespace

Drupal\rules\Core
View source
abstract class RulesConditionBase extends ConditionPluginBase implements RulesConditionInterface {
    use ContextProviderTrait;
    use ExecutablePluginTrait;
    use ConfigurationAccessControlTrait;
    
    /**
     * {@inheritdoc}
     */
    public function refineContextDefinitions(array $selected_data) {
        // Do not refine anything by default.
    }
    
    /**
     * {@inheritdoc}
     */
    public function assertMetadata(array $selected_data) {
        // Nothing to assert by default.
        return [];
    }
    
    /**
     * {@inheritdoc}
     */
    public function getContextValue($name) {
        try {
            return parent::getContextValue($name);
        } catch (ContextException $e) {
            // Catch the undocumented exception thrown when no context value is set
            // for a required context.
            // @todo Remove once https://www.drupal.org/node/2677162 is fixed.
            if (strpos($e->getMessage(), 'context is required') === FALSE) {
                throw $e;
            }
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function negate($negate = TRUE) {
        $this->configuration['negate'] = $negate;
        return $this;
    }
    
    /**
     * {@inheritdoc}
     */
    public function evaluate() {
        // Provide a reasonable default implementation that calls doEvaluate() while
        // passing the defined context as arguments.
        $args = [];
        foreach ($this->getContextDefinitions() as $name => $definition) {
            $value = $this->getContextValue($name);
            $type = $definition->toArray()['type'];
            if (substr($type, 0, 6) == 'entity') {
                if (is_array($value) && is_string($value[0])) {
                    $value = array_map([
                        $this,
                        'upcastEntityId',
                    ], $value, array_fill(0, count($value), $type));
                }
                elseif (is_string($value)) {
                    $value = $this->upcastEntityId($value, $type);
                }
            }
            $args[$name] = $value;
        }
        return call_user_func_array([
            $this,
            'doEvaluate',
        ], $args);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ConditionPluginBase::$executableManager protected property The condition manager to proxy execute calls through.
ConditionPluginBase::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm 6
ConditionPluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ConditionPluginBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration 6
ConditionPluginBase::execute public function Executes the plugin. Overrides ExecutableInterface::execute
ConditionPluginBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ConditionPluginBase::isNegated public function Determines whether condition result will be negated. Overrides ConditionInterface::isNegated
ConditionPluginBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ConditionPluginBase::setExecutableManager public function Sets the executable manager class. Overrides ConditionInterface::setExecutableManager
ConditionPluginBase::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm 6
ConditionPluginBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
ConditionPluginBase::__construct public function 5
ConfigurationAccessControlTrait::checkConfigurationAccess public function Checks configuration permission.
ContextAwarePluginAssignmentTrait::addContextAssignmentElement protected function Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler protected function Wraps the context handler.
ContextAwarePluginAssignmentTrait::t abstract protected function Ensures the t() method is available.
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::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.
ExecutablePluginBase::getConfig public function Gets all configuration values.
ExecutablePluginBase::getConfigDefinition public function Gets the definition of a configuration option.
ExecutablePluginBase::getConfigDefinitions public function Gets an array of definitions of available configuration options.
ExecutablePluginBase::setConfig public function Sets the value of a particular configuration option.
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
RulesConditionBase::assertMetadata public function Asserts additional metadata for the selected data. Overrides ContextAwarePluginInterface::assertMetadata 1
RulesConditionBase::evaluate public function Evaluates the condition and returns TRUE or FALSE accordingly. Overrides ConditionInterface::evaluate 5
RulesConditionBase::getContextValue public function Gets the value for a defined context. Overrides ContextAwarePluginTrait::getContextValue
RulesConditionBase::negate public function Negates the result after evaluating this condition. Overrides RulesConditionInterface::negate
RulesConditionBase::refineContextDefinitions public function Refines used and provided context definitions based upon context values. Overrides ContextAwarePluginInterface::refineContextDefinitions 1