class Sequence in Drupal 10

Defines a configuration element of type Sequence.

This object may contain any number and type of nested elements that share a common definition in the 'sequence' property of the configuration schema.

Read https://www.drupal.org/node/1905070 for more details about configuration schema, types and type resolution.

Note that sequences implement the typed data ComplexDataInterface (via the parent ArrayElement) rather than the ListInterface. This is because sequences may have named keys, which is not supported by ListInterface. From the typed data API perspective sequences are handled as ordered mappings without metadata about existing properties.

Hierarchy

• class \Drupal\Core\TypedData\TypedData implements PluginInspectionInterface, TypedDataInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
  • class \Drupal\Core\Config\Schema\Element
    • class \Drupal\Core\Config\Schema\ArrayElement implements \Drupal\Core\Config\Schema\IteratorAggregate, TypedConfigInterface, ComplexDataInterface
      • class \Drupal\Core\Config\Schema\Sequence

1 file declares its use of Sequence

StorableConfigBase.php in core/lib/Drupal/Core/Config/StorableConfigBase.php

2 string references to 'Sequence'

core.data_types.schema.yml in core/config/schema/core.data_types.schema.yml

core/config/schema/core.data_types.schema.yml

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/Sequence.php, line 20

Namespace

Drupal\Core\Config\Schema

class Sequence extends ArrayElement {

  /**
   * {@inheritdoc}
   */
  protected function getElementDefinition($key) {
    $value = $this->value[$key] ?? NULL;

    // @todo: Remove BC layer for sequence with hyphen in front. https://www.drupal.org/node/2444979
    $definition = [];
    if (isset($this->definition['sequence'][0])) {
      $definition = $this->definition['sequence'][0];
    }
    elseif ($this->definition['sequence']) {
      $definition = $this->definition['sequence'];
    }
    return $this
      ->buildDataDefinition($definition, $value, $key);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ArrayElement::$elements	protected	property	Parsed elements.
ArrayElement::buildDataDefinition	protected	function	Creates a new data definition object from a type definition array and actual configuration data.
ArrayElement::createElement	protected	function	Creates a contained typed configuration object.
ArrayElement::get	public	function	Gets a contained typed configuration element. Overrides TypedConfigInterface::get
ArrayElement::getAllKeys	protected	function	Gets valid configuration data keys.
ArrayElement::getElements	public	function	Gets an array of contained elements. Overrides TypedConfigInterface::getElements
ArrayElement::getIterator	public	function
ArrayElement::getProperties	public	function	Gets an array of property objects. Overrides ComplexDataInterface::getProperties
ArrayElement::isEmpty	public	function	Determines whether the data structure is empty. Overrides TypedConfigInterface::isEmpty
ArrayElement::isNullable	public	function	Determines if this element allows NULL as a value.
ArrayElement::onChange	public	function	React to changes to a child property or item. Overrides TraversableTypedDataInterface::onChange
ArrayElement::parse	protected	function	Builds an array of contained elements.
ArrayElement::set	public	function	Sets a property value. Overrides ComplexDataInterface::set
ArrayElement::toArray	public	function	Returns an array of all property values. Overrides TypedConfigInterface::toArray
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
Element::$value	protected	property	The configuration value.
Element::getTypedDataManager	public	function	Gets the typed configuration manager. Overrides TypedDataTrait::getTypedDataManager
Element::setTypedDataManager	public	function	Sets the typed config manager. Overrides TypedDataTrait::setTypedDataManager
Sequence::getElementDefinition	protected	function	Gets data definition object for contained element. Overrides ArrayElement::getElementDefinition
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	3
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	1
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.
TypedData::$definition	protected	property	The data definition.	1
TypedData::$name	protected	property	The property name.
TypedData::$parent	protected	property	The parent typed data object.
TypedData::applyDefaultValue	public	function	Applies the default value. Overrides TypedDataInterface::applyDefaultValue	2
TypedData::createInstance	public static	function	Constructs a TypedData object given its definition and context. Overrides TypedDataInterface::createInstance
TypedData::getConstraints	public	function	Gets a list of validation constraints. Overrides TypedDataInterface::getConstraints	9
TypedData::getDataDefinition	public	function	Gets the data definition. Overrides TypedDataInterface::getDataDefinition
TypedData::getName	public	function	Returns the name of a property or item. Overrides TypedDataInterface::getName
TypedData::getParent	public	function	Returns the parent data structure; i.e. either complex data or a list. Overrides TypedDataInterface::getParent
TypedData::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
TypedData::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
TypedData::getPropertyPath	public	function	Returns the property path of the data. Overrides TypedDataInterface::getPropertyPath
TypedData::getRoot	public	function	Returns the root of the typed data tree. Overrides TypedDataInterface::getRoot
TypedData::getString	public	function	Returns a string representation of the data. Overrides TypedDataInterface::getString	3
TypedData::getValue	public	function	Gets the data value. Overrides TypedDataInterface::getValue	8
TypedData::setContext	public	function	Sets the context of a property or item via a context aware parent. Overrides TypedDataInterface::setContext
TypedData::setValue	public	function	Sets the data value. Overrides TypedDataInterface::setValue	7
TypedData::validate	public	function	Validates the currently set data value. Overrides TypedDataInterface::validate
TypedData::__construct	public	function	Constructs a TypedData object given its definition and context.	3
TypedDataTrait::$typedDataManager	protected	property	The typed data manager used for creating the data types.