class SequenceDataDefinition

Same name in other branches
  1. 9 core/lib/Drupal/Core/Config/Schema/SequenceDataDefinition.php \Drupal\Core\Config\Schema\SequenceDataDefinition
  2. 10 core/lib/Drupal/Core/Config/Schema/SequenceDataDefinition.php \Drupal\Core\Config\Schema\SequenceDataDefinition
  3. 11.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

Expanded class hierarchy of SequenceDataDefinition

2 files declare their use of SequenceDataDefinition
StorableConfigBase.php in core/lib/Drupal/Core/Config/StorableConfigBase.php
TypedConfigTest.php in core/tests/Drupal/KernelTests/Config/TypedConfigTest.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 isset($this->definition['orderby']) ? $this->definition['orderby'] : NULL;
    }

}

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 Adds a validation constraint. Overrides DataDefinitionInterface::addConstraint
DataDefinition::getConstraint public function Returns a validation constraint. Overrides DataDefinitionInterface::getConstraint
DataDefinition::getConstraints public function Returns an array of validation constraints. Overrides DataDefinitionInterface::getConstraints 1
DataDefinition::getDescription public function Returns a human readable description. Overrides DataDefinitionInterface::getDescription
DataDefinition::getLabel public function Returns a human readable label. Overrides DataDefinitionInterface::getLabel
DataDefinition::getSetting public function Returns the value of a given setting. Overrides DataDefinitionInterface::getSetting 2
DataDefinition::getSettings public function Returns the array of settings, as required by the used class. Overrides DataDefinitionInterface::getSettings 2
DataDefinition::isComputed public function Determines whether the data value is computed. Overrides DataDefinitionInterface::isComputed
DataDefinition::isInternal public function Determines whether the data value is internal. Overrides DataDefinitionInterface::isInternal 1
DataDefinition::isList public function Returns whether the data is multi-valued, i.e. a list of data items. Overrides DataDefinitionInterface::isList
DataDefinition::isReadOnly public function Determines whether the data is read-only. Overrides DataDefinitionInterface::isReadOnly
DataDefinition::isRequired public function Determines whether a data value is required. 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 Creates a new data definition object. Overrides DataDefinition::createFromDataType
ListDataDefinition::createFromItemType public static function Creates a new list data definition for items of the given data type. Overrides ListDataDefinitionInterface::createFromItemType 1
ListDataDefinition::getClass public function Returns the class used for creating the typed data object. Overrides DataDefinition::getClass
ListDataDefinition::getDataType public function Returns the data type of the data. Overrides DataDefinition::getDataType
ListDataDefinition::getItemDefinition public function Gets the data definition of an item of the list. Overrides ListDataDefinitionInterface::getItemDefinition
ListDataDefinition::setDataType public function Sets the data type. 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 Constructs a new data definition object. Overrides DataDefinition::__construct
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.