class SequenceDataDefinition

Same name in other branches
  1. 9 core/lib/Drupal/Core/Config/Schema/SequenceDataDefinition.php \Drupal\Core\Config\Schema\SequenceDataDefinition
  2. 8.9.x core/lib/Drupal/Core/Config/Schema/SequenceDataDefinition.php \Drupal\Core\Config\Schema\SequenceDataDefinition
  3. 10 core/lib/Drupal/Core/Config/Schema/SequenceDataDefinition.php \Drupal\Core\Config\Schema\SequenceDataDefinition

A typed data definition class for defining sequences in configuration.

Hierarchy

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\Schema
View 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

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DataDefinition::$definition protected property The array holding values for all definition keys.
DataDefinition::addConstraint public function Overrides DataDefinitionInterface::addConstraint
DataDefinition::getConstraint public function Overrides DataDefinitionInterface::getConstraint
DataDefinition::getConstraints public function Overrides DataDefinitionInterface::getConstraints 1
DataDefinition::getDescription public function Overrides DataDefinitionInterface::getDescription
DataDefinition::getLabel public function Overrides DataDefinitionInterface::getLabel 1
DataDefinition::getSetting public function Overrides DataDefinitionInterface::getSetting 2
DataDefinition::getSettings public function Overrides DataDefinitionInterface::getSettings 2
DataDefinition::isComputed public function Overrides DataDefinitionInterface::isComputed
DataDefinition::isInternal public function Overrides DataDefinitionInterface::isInternal 1
DataDefinition::isList public function Overrides DataDefinitionInterface::isList
DataDefinition::isReadOnly public function Overrides DataDefinitionInterface::isReadOnly
DataDefinition::isRequired public function Overrides DataDefinitionInterface::isRequired
DataDefinition::offsetExists public function This is for BC support only.
@todo Remove in https://www.drupal.org/node/1928868.
DataDefinition::offsetGet public function This is for BC support only.
@todo Remove in https://www.drupal.org/node/1928868.
DataDefinition::offsetSet public function This is for BC support only.
@todo Remove in https://www.drupal.org/node/1928868.
DataDefinition::offsetUnset public function This is for BC support only.
@todo Remove in https://www.drupal.org/node/1928868.
DataDefinition::setClass public function Sets the class used for creating the typed data object.
DataDefinition::setComputed public function Sets whether the data is computed.
DataDefinition::setConstraints public function Sets an array of validation constraints.
DataDefinition::setDescription public function Sets the human-readable description.
DataDefinition::setInternal public function Sets the whether the data value should be internal.
DataDefinition::setLabel public function Sets the human-readable label.
DataDefinition::setReadOnly public function Sets whether the data is read-only.
DataDefinition::setRequired public function Sets whether the data is required.
DataDefinition::setSetting public function Sets a definition setting. 2
DataDefinition::setSettings public function Sets the array of settings, as required by the used class. 2
DataDefinition::toArray public function Returns all definition values as array.
DataDefinition::__sleep public function 2
ListDataDefinition::$itemDefinition protected property The data definition of a list item.
ListDataDefinition::create public static function Creates a new list definition. Overrides DataDefinition::create 1
ListDataDefinition::createFromDataType public static function Overrides DataDefinition::createFromDataType
ListDataDefinition::createFromItemType public static function Overrides ListDataDefinitionInterface::createFromItemType 1
ListDataDefinition::getClass public function Overrides DataDefinition::getClass
ListDataDefinition::getItemDefinition public function Overrides ListDataDefinitionInterface::getItemDefinition
ListDataDefinition::setDataType public function Overrides DataDefinition::setDataType
ListDataDefinition::setItemDefinition public function Sets the item definition.
ListDataDefinition::__clone public function Magic method: Implements a deep clone. 1
ListDataDefinition::__construct public function Overrides DataDefinition::__construct
SequenceDataDefinition::getDataType public function Overrides ListDataDefinition::getDataType
SequenceDataDefinition::getOrderBy public function Gets the description of how the sequence should be sorted.
TypedDataTrait::$typedDataManager protected property The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager public function Gets the typed data manager. 2
TypedDataTrait::setTypedDataManager public function Sets the typed data manager. 2

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.