1. class
  2. Drupal
  3. \
  4. Component
  5. \
  6. Plugin
  7. \
  8. Context
  9. \
  10. Context

Context

class Context implements ContextInterface (View source)

A generic context class for wrapping data a plugin needs to operate.

Properties

protected mixed $contextValue

The value of the context.
protected ContextDefinitionInterface $contextDefinition

The definition to which a context must conform.

Methods

__construct(ContextDefinitionInterface $context_definition, mixed|null $context_value = NULL)

Create a context object.

mixed
getContextValue()

Gets the context value.

bool
hasContextValue()

Returns whether the context has a value.

ContextDefinitionInterface
getContextDefinition()

Gets the provided definition that the context must conform to.

array
getConstraints()

Gets a list of validation constraints.

ConstraintViolationListInterface
validate()

Validates the set context value.

Details

at line 36
__construct(ContextDefinitionInterface $context_definition, mixed|null $context_value = NULL)

Create a context object.

Parameters

ContextDefinitionInterface $context_definition

The context definition.
mixed|null $context_value

The value of the context.

at line 44
mixed getContextValue()

Gets the context value.

Return Value

mixed

The currently set context value, or NULL if it is not set.

at line 64
bool hasContextValue()

Returns whether the context has a value.

Return Value

bool

TRUE if the context has a value, FALSE otherwise.

at line 71
ContextDefinitionInterface getContextDefinition()

Gets the provided definition that the context must conform to.

Return Value

ContextDefinitionInterface

The defining characteristic representation of the context.

at line 78
array getConstraints()

Gets a list of validation constraints.

Return Value

array

Array of constraints, each being an instance of \Symfony\Component\Validator\Constraint.

at line 88
ConstraintViolationListInterface validate()

Validates the set context value.

Return Value

ConstraintViolationListInterface

A list of constraint violations. If the list is empty, validation succeeded.