class DataComparison

Provides a 'Data comparison' condition.

@todo Add access callback information from Drupal 7. @todo Find a way to port rules_condition_data_is_operator_options() from Drupal 7.

Plugin annotation


@Condition(
  id = "rules_data_comparison",
  label = @Translation("Data comparison"),
  category = @Translation("Data"),
  context_definitions = {
    "data" = @ContextDefinition("any",
      label = @Translation("Data to compare"),
      description = @Translation("The data to be compared, specified by using a data selector, e.g. 'node.uid.entity.name.value'."),
      assignment_restriction = "selector"
    ),
    "operation" = @ContextDefinition("string",
      label = @Translation("Operator"),
      description = @Translation("The comparison operator. Valid values are == (default), <, >, CONTAINS (for strings or arrays) and IN (for arrays or lists)."),
      assignment_restriction = "input",
      default_value = "==",
      options_provider = "\Drupal\rules\TypedData\Options\ComparisonOperatorOptions",
      required = FALSE
    ),
    "value" = @ContextDefinition("any",
      label = @Translation("Data value"),
      description = @Translation("The value to compare the data with.")
    ),
  }
)

Hierarchy

Expanded class hierarchy of DataComparison

File

src/Plugin/Condition/DataComparison.php, line 38

Namespace

Drupal\rules\Plugin\Condition
View source 
class DataComparison extends RulesConditionBase {
    
    /**
     * Evaluate the data comparison.
     *
     * @param mixed $data
     *   Supplied data to test.
     * @param string $operation
     *   Data comparison operation. Typically one of:
     *     - "=="
     *     - "<"
     *     - ">"
     *     - "contains" (for strings or arrays)
     *     - "IN" (for arrays or lists).
     * @param mixed $value
     *   The value to be compared against $data.
     *
     * @return bool
     *   The evaluation of the condition.
     */
    protected function doEvaluate($data, $operation, $value) {
        $operation = $operation ? strtolower($operation) : '==';
        switch ($operation) {
            case '<':
                return $data < $value;
            case '>':
                return $data > $value;
            case 'contains':
                return is_string($data) && strpos($data, $value) !== FALSE || is_array($data) && in_array($value, $data);
            case 'in':
                return is_array($value) && in_array($data, $value);
            case '==':
            default:
                // In case both values evaluate to FALSE, further differentiate between
                // NULL values and values evaluating to FALSE.
                if (!$data && !$value) {
                    return isset($data) && isset($value) || !isset($data) && !isset($value);
                }
                return $data == $value;
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function refineContextDefinitions(array $selected_data) {
        if (isset($selected_data['data'])) {
            $this->pluginDefinition['context_definitions']['value']
                ->setDataType($selected_data['data']->getDataType());
            if ($this->getContextValue('operation') == 'IN') {
                $this->pluginDefinition['context_definitions']['value']
                    ->setMultiple();
            }
        }
    }

}

Members

Title 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&#039;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.
DataComparison::doEvaluate protected function Evaluate the data comparison.
DataComparison::refineContextDefinitions public function Refines used and provided context definitions based upon context values. Overrides RulesConditionBase::refineContextDefinitions
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