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

ContextDefinitionInterface

interface ContextDefinitionInterface (View source)

Interface used to define definition objects found in ContextInterface.

WARNING: This interface is going to receive some additions as part of https://www.drupal.org/node/2346999.

Methods

string
getLabel()

Gets a human readable label.

$this
setLabel(string $label)

Sets the human readable label.

string|null
getDescription()

Gets a human readable description.

$this
setDescription(string|null $description)

Sets the human readable description.

string
getDataType()

Gets the data type needed by the context.

$this
setDataType(string $data_type)

Sets the data type needed by the context.

bool
isMultiple()

Determines whether the data is multi-valued, i.e. a list of data items.

$this
setMultiple(bool $multiple = TRUE)

Sets whether the data is multi-valued.

bool
isRequired()

Determines whether the context is required.

$this
setRequired(bool $required = TRUE)

Sets whether the data is required.

mixed
getDefaultValue()

Gets the default value for this context definition.

$this
setDefaultValue(mixed $default_value)

Sets the default data value.

array
getConstraints()

Gets an array of validation constraints.

$this
setConstraints(array $constraints)

Sets the array of validation constraints.

$this
addConstraint(string $constraint_name, array|null $options = NULL)

Adds a validation constraint.

array
getConstraint(string $constraint_name)

Gets a validation constraint.

Details

at line 21
string getLabel()

Gets a human readable label.

Return Value

string

The label.

at line 31
$this setLabel(string $label)

Sets the human readable label.

Parameters

string $label

The label to set.

Return Value

$this

at line 39
string|null getDescription()

Gets a human readable description.

Return Value

string|null

The description, or NULL if no description is available.

at line 49
$this setDescription(string|null $description)

Sets the human readable description.

Parameters

string|null $description

The description to set.

Return Value

$this

at line 59
string getDataType()

Gets the data type needed by the context.

If the context is multiple-valued, this represents the type of each value.

Return Value

string

The data type.

at line 69
$this setDataType(string $data_type)

Sets the data type needed by the context.

Parameters

string $data_type

The data type to set.

Return Value

$this

at line 77
bool isMultiple()

Determines whether the data is multi-valued, i.e. a list of data items.

Return Value

bool

Whether the data is multi-valued; i.e. a list of data items.

at line 87
$this setMultiple(bool $multiple = TRUE)

Sets whether the data is multi-valued.

Parameters

bool $multiple

(optional) Whether the data is multi-valued. Defaults to TRUE.

Return Value

$this

at line 97
bool isRequired()

Determines whether the context is required.

For required data a non-NULL value is mandatory.

Return Value

bool

Whether a data value is required.

at line 107
$this setRequired(bool $required = TRUE)

Sets whether the data is required.

Parameters

bool $required

(optional) Whether the data is multi-valued. Defaults to TRUE.

Return Value

$this

at line 115
mixed getDefaultValue()

Gets the default value for this context definition.

Return Value

mixed

The default value or NULL if no default value is set.

at line 125
$this setDefaultValue(mixed $default_value)

Sets the default data value.

Parameters

mixed $default_value

The default value to be set or NULL to remove any default value.

Return Value

$this

at line 135
array getConstraints()

Gets an array of validation constraints.

Return Value

array

An array of validation constraint definitions, keyed by constraint name. Each constraint definition can be used for instantiating \Symfony\Component\Validator\Constraint objects.

at line 150
$this setConstraints(array $constraints)

Sets the array of validation constraints.

NOTE: This will override any previously set constraints. In most cases ContextDefinitionInterface::addConstraint() should be used instead.

Parameters

array $constraints

The array of constraints.

Return Value

$this

See also

\Drupal\Component\Plugin\Context\self::addConstraint()

at line 162
$this addConstraint(string $constraint_name, array|null $options = NULL)

Adds a validation constraint.

Parameters

string $constraint_name

The name of the constraint to add, i.e. its plugin id.
array|null $options

The constraint options as required by the constraint plugin, or NULL.

Return Value

$this

at line 174
array getConstraint(string $constraint_name)

Gets a validation constraint.

Parameters

string $constraint_name

The name of the constraint, i.e. its plugin id.

Return Value

array

A validation constraint definition which can be used for instantiating a \Symfony\Component\Validator\Constraint object.