class DataIsEmpty

Provides a 'Data value is empty' condition.

@todo Add access callback information from Drupal 7.

Plugin annotation

@Condition(
  id = "rules_data_is_empty",
  label = @Translation("Data value is empty"),
  category = @Translation("Data"),
  context_definitions = {
    "data" = @ContextDefinition("any",
      label = @Translation("Data to check"),
      description = @Translation("The data to be checked to be empty, specified by using a data selector, e.g. 'node.uid.entity.name.value'."),
      assignment_restriction = "selector"
    ),
  }
)

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\rules\Plugin\Condition\DataIsEmpty extends \Drupal\rules\Core\RulesConditionBase

Expanded class hierarchy of DataIsEmpty

File

src/Plugin/Condition/DataIsEmpty.php, line 30

Namespace

class DataIsEmpty extends RulesConditionBase {
    
    /**
     * {@inheritdoc}
     */
    public function evaluate() {
        $data = $this->getContext('data')
            ->getContextData();
        if ($data instanceof ComplexDataInterface || $data instanceof ListInterface) {
            return $data->isEmpty();
        }
        $value = $data->getValue();
        // For some primitives we can rely on PHP's type casting to boolean.
        if ($data instanceof StringInterface || $data instanceof IntegerInterface || $data instanceof BooleanInterface) {
            return !isset($value) || !$value;
        }
        return !isset($value);
    }

}

Members