public function PagerSelectExtender::element in Drupal 8

Same name and namespace in other branches

1. 9 core/lib/Drupal/Core/Database/Query/PagerSelectExtender.php \Drupal\Core\Database\Query\PagerSelectExtender::element()

Specify the element ID for this pager query.

The element is used to differentiate different pager queries on the same page so that they may be operated independently. If you do not specify an element, every pager query on the page will get a unique element. If for whatever reason you want to explicitly define an element for a given query, you may do so here.

Setting the element here also increments the static $maxElement counter, which is used for determining the $element when there's none specified.

Note that no collision detection is done when setting an element ID explicitly, so it is possible for two pagers to end up using the same ID if both are set explicitly.

Parameters

$element: Element ID that is used to differentiate different pager queries.

File

core/lib/Drupal/Core/Database/Query/PagerSelectExtender.php, line 164

Class

PagerSelectExtender

Query extender for pager queries.

Namespace

Drupal\Core\Database\Query

Code

public function element($element) {
  $this->element = $element;
  if ($element >= self::$maxElement) {
    self::$maxElement = $element + 1;
  }
  return $this;
}