function QueryBase::range

Same name and namespace in other branches
  1. 8.9.x core/lib/Drupal/Core/Entity/Query/QueryBase.php \Drupal\Core\Entity\Query\QueryBase::range()
  2. 10 core/lib/Drupal/Core/Entity/Query/QueryBase.php \Drupal\Core\Entity\Query\QueryBase::range()
  3. 11.x core/lib/Drupal/Core/Entity/Query/QueryBase.php \Drupal\Core\Entity\Query\QueryBase::range()

Defines the range of the query.

Parameters

int|null $start: (optional) The first record from the result set to return. If NULL, removes any range directives that are set.

int|null $length: (optional) The maximum number of rows to return. If $start and $length are NULL, then a complete result set will be generated. If $start is not NULL and $length is NULL, then an empty result set will be generated.

Return value

$this

Overrides QueryInterface::range

1 call to QueryBase::range()
QueryBase::initializePager in core/lib/Drupal/Core/Entity/Query/QueryBase.php
Gets the total number of results and initialize a pager for the query.

File

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

Class

QueryBase
The base entity query class.

Namespace

Drupal\Core\Entity\Query

Code

public function range($start = NULL, $length = NULL) {
    $this->range = [
        'start' => $start,
        'length' => $length,
    ];
    return $this;
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.