function SequenceDataDefinition::getOrderBy
Same name in other branches
- 9 core/lib/Drupal/Core/Config/Schema/SequenceDataDefinition.php \Drupal\Core\Config\Schema\SequenceDataDefinition::getOrderBy()
- 8.9.x core/lib/Drupal/Core/Config/Schema/SequenceDataDefinition.php \Drupal\Core\Config\Schema\SequenceDataDefinition::getOrderBy()
- 11.x 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\SchemaCode
public function getOrderBy() {
return $this->definition['orderby'] ?? NULL;
}
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.