class RulesConditionBase
Base class for rules conditions.
@todo Figure out whether buildConfigurationForm() is useful to Rules somehow.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\Core\Executable\ExecutablePluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Executable\ExecutableInterface, \Drupal\Core\Cache\CacheableDependencyInterface, \Drupal\Core\Plugin\ContextAwarePluginInterface uses \Drupal\Core\Plugin\ContextAwarePluginTrait
- class \Drupal\Core\Condition\ConditionPluginBase extends \Drupal\Core\Executable\ExecutablePluginBase implements \Drupal\Core\Condition\ConditionInterface uses \Drupal\Core\Plugin\ContextAwarePluginAssignmentTrait
- class \Drupal\rules\Core\RulesConditionBase extends \Drupal\Core\Condition\ConditionPluginBase implements \Drupal\rules\Core\RulesConditionInterface uses \Drupal\rules\Context\ContextProviderTrait, \Drupal\rules\Core\ExecutablePluginTrait, \Drupal\rules\Core\ConfigurationAccessControlTrait
- class \Drupal\Core\Condition\ConditionPluginBase extends \Drupal\Core\Executable\ExecutablePluginBase implements \Drupal\Core\Condition\ConditionInterface uses \Drupal\Core\Plugin\ContextAwarePluginAssignmentTrait
- class \Drupal\Core\Executable\ExecutablePluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Executable\ExecutableInterface, \Drupal\Core\Cache\CacheableDependencyInterface, \Drupal\Core\Plugin\ContextAwarePluginInterface uses \Drupal\Core\Plugin\ContextAwarePluginTrait
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
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
File
-
src/
Core/ RulesConditionBase.php, line 14
Namespace
Drupal\rules\CoreView 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);
}
}