public function SequenceDataDefinition::getOrderBy in Drupal 8

Same name and namespace in other branches

1. 9 core/lib/Drupal/Core/Config/Schema/SequenceDataDefinition.php \Drupal\Core\Config\Schema\SequenceDataDefinition::getOrderBy()
2. 10 core/lib/Drupal/Core/Config/Schema/SequenceDataDefinition.php \Drupal\Core\Config\Schema\SequenceDataDefinition::getOrderBy()

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 value

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).

File

core/lib/Drupal/Core/Config/Schema/SequenceDataDefinition.php, line 24

Class

SequenceDataDefinition

A typed data definition class for defining sequences in configuration.

Namespace

Drupal\Core\Config\Schema

Code

public function getOrderBy() {
  return isset($this->definition['orderby']) ? $this->definition['orderby'] : NULL;
}