class OptionalContextCondition

Provides a condition with an optional node context.

The context type entity:node is used since that would allow to also use this for web tests with the node route context.

Plugin annotation

@Condition(
  id = "condition_test_optional_context",
  label = @Translation("Optional context"),
  context_definitions = {
    "node" = @ContextDefinition("entity:node", label = @Translation("Node"), required = FALSE),
  }
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
    • class \Drupal\Core\Executable\ExecutablePluginBase extends \Drupal\Core\Executable\ExecutableInterface, \Drupal\Core\Cache\CacheableDependencyInterface, \Drupal\Core\Plugin\ContextAwarePluginInterface uses \Drupal\Core\Plugin\ContextAwarePluginTrait implements \Drupal\Core\Plugin\PluginBase
      • class \Drupal\Core\Condition\ConditionPluginBase extends \Drupal\Core\Condition\ConditionInterface uses \Drupal\Core\Plugin\ContextAwarePluginAssignmentTrait implements \Drupal\Core\Executable\ExecutablePluginBase
        • class \Drupal\condition_test\Plugin\Condition\OptionalContextCondition implements \Drupal\Core\Condition\ConditionPluginBase

Expanded class hierarchy of OptionalContextCondition

File

core/modules/system/tests/modules/condition_test/src/Plugin/Condition/OptionalContextCondition.php, line 21

Namespace

class OptionalContextCondition extends ConditionPluginBase {
    
    /**
     * {@inheritdoc}
     */
    public function evaluate() {
        // Grant access if no context value is given.
        return !$this->getContextValue('node');
    }
    
    /**
     * {@inheritdoc}
     */
    public function summary() {
        return $this->t('Context with optional context.');
    }

}

Members