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

EntityFieldQuery The called object.

File

drupal-7.x/includes/entity.inc, line 968

Class

EntityFieldQuery

Retrieves entities matching a given set of conditions.

Code

public function pager($limit = 10, $element = NULL) {
  if (!isset($element)) {
    $element = PagerDefault::$maxElement++;
  }
  elseif ($element >= PagerDefault::$maxElement) {
    PagerDefault::$maxElement = $element + 1;
  }

  $this->pager = array(
    'limit' => $limit,
    'element' => $element,
  );
  return $this;
}