class Sequence

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 \Drupal\Core\TypedData\TypedDataInterface, \Drupal\Component\Plugin\PluginInspectionInterface uses \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\TypedData\TypedDataTrait
  • class \Drupal\Core\Config\Schema\Element extends \Drupal\Core\TypedData\TypedData
    • class \Drupal\Core\Config\Schema\ArrayElement implements \Drupal\Core\Config\Schema\IteratorAggregate, \Drupal\Core\Config\Schema\TypedConfigInterface, \Drupal\Core\TypedData\ComplexDataInterface extends \Drupal\Core\Config\Schema\Element
      • class \Drupal\Core\Config\Schema\Sequence extends \Drupal\Core\Config\Schema\ArrayElement

Expanded class hierarchy of Sequence

File

core/lib/Drupal/Core/Config/Schema/Sequence.php, line 20

Namespace

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