class SequenceDataDefinition
Same name and namespace in other branches
- 10 core/lib/Drupal/Core/Config/Schema/SequenceDataDefinition.php \Drupal\Core\Config\Schema\SequenceDataDefinition
- 9 core/lib/Drupal/Core/Config/Schema/SequenceDataDefinition.php \Drupal\Core\Config\Schema\SequenceDataDefinition
- 8.9.x core/lib/Drupal/Core/Config/Schema/SequenceDataDefinition.php \Drupal\Core\Config\Schema\SequenceDataDefinition
A typed data definition class for defining sequences in configuration.
Hierarchy
- class \Drupal\Core\TypedData\DataDefinition implements \Drupal\Core\TypedData\DataDefinitionInterface, \Drupal\Core\TypedData\ArrayAccess uses \Drupal\Core\TypedData\TypedDataTrait
- class \Drupal\Core\TypedData\ListDataDefinition implements \Drupal\Core\TypedData\ListDataDefinitionInterface extends \Drupal\Core\TypedData\DataDefinition
- class \Drupal\Core\Config\Schema\SequenceDataDefinition extends \Drupal\Core\TypedData\ListDataDefinition
- class \Drupal\Core\TypedData\ListDataDefinition implements \Drupal\Core\TypedData\ListDataDefinitionInterface extends \Drupal\Core\TypedData\DataDefinition
Expanded class hierarchy of SequenceDataDefinition
4 files declare their use of SequenceDataDefinition
- StorableConfigBase.php in core/
lib/ Drupal/ Core/ Config/ StorableConfigBase.php - TypedConfigManager.php in core/
lib/ Drupal/ Core/ Config/ TypedConfigManager.php - TypedConfigTest.php in core/
tests/ Drupal/ KernelTests/ Config/ TypedConfigTest.php - ValidKeysConstraintValidator.php in core/
lib/ Drupal/ Core/ Validation/ Plugin/ Validation/ Constraint/ ValidKeysConstraintValidator.php
1 string reference to 'SequenceDataDefinition'
- core.data_types.schema.yml in core/
config/ schema/ core.data_types.schema.yml - core/config/schema/core.data_types.schema.yml
File
-
core/
lib/ Drupal/ Core/ Config/ Schema/ SequenceDataDefinition.php, line 10
Namespace
Drupal\Core\Config\SchemaView source
class SequenceDataDefinition extends ListDataDefinition {
/**
* 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.
*
* @return string|null
* May be 'key' (to sort by key), 'value' (to sort by value, discarding
* keys), or NULL (if the schema does not describe how the sequence should
* be sorted).
*/
public function getOrderBy() {
return $this->definition['orderby'] ?? NULL;
}
/**
* {@inheritdoc}
*/
public function getDataType() {
// TRICKY: this class extends ListDataDefinition, which always returns a
// hardcoded "list". But this is a typed data type used in config schemas,
// and hence many subtypes of it exists. The actual concrete subtype must
// always be returned.
// This effectively means skipping the parent implementation and matching
// the grandparent implementation.
// @see \Drupal\Core\TypedData\ListDataDefinition::setDataType()
// @see \Drupal\Core\TypedData\ListDataDefinition::getDataType()
return $this->definition['type'];
}
}
Members
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.