public function QueryBase::pager in Drupal 8

Same name and namespace in other branches

1. 9 core/lib/Drupal/Core/Entity/Query/QueryBase.php \Drupal\Core\Entity\Query\QueryBase::pager()

Enables a pager for the query.

Parameters

$limit: An integer specifying the number of elements per page. If passed a false value (FALSE, 0, NULL), the pager is disabled.

$element: An optional integer to distinguish between multiple pagers on one page. If not provided, one is automatically calculated.

Return value

$this The called object.

Overrides QueryInterface::pager

File

core/lib/Drupal/Core/Entity/Query/QueryBase.php, line 288

Class

QueryBase

The base entity query class.

Namespace

Drupal\Core\Entity\Query

Code

public function pager($limit = 10, $element = NULL) {

  // Even when not using SQL, storing the element PagerSelectExtender is as
  // good as anywhere else.
  if (!isset($element)) {
    $element = PagerSelectExtender::$maxElement++;
  }
  elseif ($element >= PagerSelectExtender::$maxElement) {
    PagerSelectExtender::$maxElement = $element + 1;
  }
  $this->pager = [
    'limit' => $limit,
    'element' => $element,
  ];
  return $this;
}