SequenceDataDefinition
class SequenceDataDefinition extends ListDataDefinition (View source)
A typed data definition class for defining sequences in configuration.
Traits
Wrapper methods for classes that needs typed data manager object.
Properties
| protected TypedDataManagerInterface | $typedDataManager | The typed data manager used for creating the data types. |
from TypedDataTrait |
| protected array | $definition | The array holding values for all definition keys. |
from DataDefinition |
| protected DataDefinitionInterface | $itemDefinition | The data definition of a list item. |
from ListDataDefinition |
Methods
Creates a new list definition.
Creates a new data definition object.
Constructs a new data definition object.
Sets the human-readable description.
Returns whether the data is multi-valued, i.e. a list of data items.
Returns the class used for creating the typed data object.
Sets the class used for creating the typed data object.
Returns the array of settings, as required by the used class.
Sets the array of settings, as required by the used class.
Sets a definition setting.
Sets an array of validation constraints.
Adds a validation constraint.
Sets the whether the data value should be internal.
Creates a new list data definition for items of the given data type.
Gets the data definition of an item of the list.
Gets the description of how the sequence should be sorted.
Details
$this
setTypedDataManager(TypedDataManagerInterface $typed_data_manager)
Sets the typed data manager.
TypedDataManagerInterface
getTypedDataManager()
Gets the typed data manager.
static DataDefinition
create(string $item_type)
Creates a new list definition.
static DataDefinitionInterface
createFromDataType($type)
Creates a new data definition object.
This method is typically used by \Drupal\Core\TypedData\TypedDataManager::createDataDefinition() to build a definition object for an arbitrary data type. When the definition class is known, it is recommended to directly use the static create() method on that class instead; e.g.:
__construct(array $values = [], DataDefinitionInterface $item_definition = NULL)
Constructs a new data definition object.
string
getDataType()
Returns the data type of the data.
DataDefinition
setDataType(string $type)
Sets the data type.
string|TranslatableMarkup
getLabel()
Returns a human readable label.
DataDefinition
setLabel(string $label)
Sets the human-readable label.
string|null
getDescription()
Returns a human readable description.
Descriptions are usually used on user interfaces where the data is edited or displayed.
DataDefinition
setDescription(string $description)
Sets the human-readable description.
bool
isList()
Returns whether the data is multi-valued, i.e. a list of data items.
This is equivalent to checking whether the data definition implements the \Drupal\Core\TypedData\ListDefinitionInterface interface.
bool
isReadOnly()
Determines whether the data is read-only.
DataDefinition
setReadOnly(bool $read_only)
Sets whether the data is read-only.
bool
isComputed()
Determines whether the data value is computed.
For example, data could be computed depending on some other values.
DataDefinition
setComputed(bool $computed)
Sets whether the data is computed.
bool
isRequired()
Determines whether a data value is required.
For required data a non-NULL value is mandatory.
DataDefinition
setRequired(bool $required)
Sets whether the data is required.
string
getClass()
Returns the class used for creating the typed data object.
If not specified, the default class of the data type will be returned.
DataDefinition
setClass(string|null $class)
Sets the class used for creating the typed data object.
array
getSettings()
Returns the array of settings, as required by the used class.
See the documentation of the class for supported or required settings.
DataDefinition
setSettings(array $settings)
Sets the array of settings, as required by the used class.
mixed
getSetting(string $setting_name)
Returns the value of a given setting.
DataDefinition
setSetting(string $setting_name, mixed $value)
Sets a definition setting.
array[]
getConstraints()
Returns an array of validation constraints.
The validation constraints of a definition consist of any for it defined constraints and default constraints, which are generated based on the definition and its data type. See \Drupal\Core\TypedData\TypedDataManager::getDefaultConstraints().
Constraints are defined via an array, having constraint plugin IDs as key and constraint options as values, e.g.
array
getConstraint(string $constraint_name)
Returns a validation constraint.
See \Drupal\Core\TypedData\DataDefinitionInterface::getConstraints() for details.
$this
setConstraints(array $constraints)
Sets an array of validation constraints.
DataDefinitionInterface
addConstraint(string $constraint_name, array|null $options = NULL)
Adds a validation constraint.
See \Drupal\Core\TypedData\DataDefinitionInterface::getConstraints() for details.
offsetExists($offset)
{@inheritdoc}
This is for BC support only.
offsetGet($offset)
{@inheritdoc}
This is for BC support only.
offsetSet($offset, $value)
{@inheritdoc}
This is for BC support only.
offsetUnset($offset)
{@inheritdoc}
This is for BC support only.
array
toArray()
Returns all definition values as array.
__sleep()
{@inheritdoc}
bool
isInternal()
Determines whether the data value is internal.
This can be used in a scenario when it is not desirable to expose this data value to an external system.
The implications of this method are left to the discretion of the caller. For example, a module providing an HTTP API may not expose entities of this type, or a custom entity reference field settings form may deprioritize entities of this type in a select list.
$this
setInternal(bool $internal)
Sets the whether the data value should be internal.
static ListDataDefinitionInterface
createFromItemType(string $item_type)
Creates a new list data definition for items of the given data type.
This method is typically used by \Drupal\Core\TypedData\TypedDataManager::createListDataDefinition() to build a definition object for an arbitrary item type. When the definition class is known, it is recommended to directly use the static create() method on that class instead; e.g.:
DataDefinitionInterface
getItemDefinition()
Gets the data definition of an item of the list.
$this
setItemDefinition(DataDefinitionInterface $definition)
Sets the item definition.
__clone()
Magic method: Implements a deep clone.
string|null
getOrderBy()
Gets the description of how the sequence should be sorted.
Only the top level of the array should be sorted. Top-level keys should be discarded when using 'value' sorting. If the sequence is an associative array 'key' sorting is recommended, if not 'value' sorting is recommended.