Класс yii\data\Pagination

Pagination представляет информацию, относящуюся к постраничному отображению элементов данных.

Когда данные необходимо отображать по страницам, Pagination может быть использована для представления такой информации, как общее количество элементов, размер страницы, текущая страница и т.д. Эта информация может быть передана страничным навигаторам для отображения кнопок или ссылок для навигации по страницам.

Следующий пример демонстрирует, как создать объект Pagination и передать его страничному навигатору.

Действие контроллера:

public function actionIndex()
{
    $query = Article::find()->where(['status' => 1]);
    $countQuery = clone $query;
    $pages = new Pagination(['totalCount' => $countQuery->count()]);
    $models = $query->offset($pages->offset)
        ->limit($pages->limit)
        ->all();

    return $this->render('index', [
         'models' => $models,
         'pages' => $pages,
    ]);
}

Представление:

foreach ($models as $model) {
    // display $model here
}

// display pagination
echo LinkPager::widget([
    'pagination' => $pages,
]);

Для получения более подробной информации и инструкций по использованию Pagination, см. статью руководства по постраничному отображению.

Публичные свойства

Публичные методы

Защищённые методы

Константы

Подробное описание свойств

$defaultPageSize общественное свойство

Размер страницы по умолчанию. Это свойство будет возвращено свойством $pageSize, когда размер страницы нельзя определить по свойству $pageSizeParam из свойства $params.

public integer $defaultPageSize = 20

$forcePageParam общественное свойство

Всегда ли включать параметр страницы в URL, созданный методом createUrl(). Если false и $page равно 0, параметр страницы не будет добавлен в URL.

public boolean $forcePageParam = true

$limit общественное только для чтения свойство

Предел данных. Это может быть использовано для установки значения LIMIT для SQL-запроса для извлечения текущей страницы данных. Обратите внимание, что если размер страницы бесконечен, будет возвращено значение -1.

public integer getLimit ( )

$links общественное только для чтения свойство

Ссылки для навигации. Ключи массива указывают назначение ссылок (например, LINK_FIRST), а значения массива — соответствующие URL.

public array getLinks ( $absolute = false )

$offset общественное только для чтения свойство

Смещение данных. Это может быть использовано для установки значения OFFSET в SQL-запросе для извлечения текущей страницы данных.

public integer getOffset ( )

$page общественное свойство

Номер текущей страницы (нумерация с нуля).

public integer getPage ( $recalculate = false )
public void setPage ( $value, $validatePage = false )

$pageCount общественное только для чтения свойство

Количество страниц

public integer getPageCount ( )

$pageParam общественное свойство

Имя параметра, хранящего индекс текущей страницы.

См. также $params.

public string $pageParam = 'page'

$pageSize общественное свойство

Количество элементов на странице. Если значение меньше 1, это означает, что размер страницы бесконечен, и, следовательно, одна страница содержит все элементы.

public integer getPageSize ( )
public void setPageSize ( $value, $validatePageSize = false )

$pageSizeLimit общественное свойство

Пределы размера страницы. Первый элемент массива — минимальный размер страницы, а второй — максимальный размер страницы. Если это false, это означает, что $pageSize всегда должен возвращать значение $defaultPageSize.

public array|false $pageSizeLimit = [1, 50]

$pageSizeParam общественное свойство

Имя параметра, хранящего размер страницы.

См. также $params.

public string $pageSizeParam = 'per-page'

$params общественное свойство

Параметры (имя => значение), которые должны быть использованы для получения текущего номера страницы и создания новых URL страниц. Если не заданы, используются все параметры из $_GET.

Для добавления хэша ко всем ссылкам используйте array_merge($_GET, ['#' => 'my-hash']).

Элемент массива с индексом $pageParam считается текущим номером страницы (по умолчанию 0); в то время как элемент с индексом $pageSizeParam обрабатывается как размер страницы (по умолчанию $defaultPageSize).

public array $params = null

$route общественное свойство

Маршрут действия контроллера для отображения постраничного содержимого. Если не задан, используется текущий запрашиваемый маршрут.

public string $route = null

$totalCount общественное свойство

Общее количество элементов.

public integer $totalCount = 0

$urlManager общественное свойство

Менеджер URL, используемый для создания URL страниц. Если не задан, используется компонент приложения «urlManager».

public yii\web\UrlManager $urlManager = null

$validatePage общественное свойство

Необходимо ли проверять, находится ли $page в допустимом диапазоне. Когда это свойство true, значение $page всегда будет находиться между 0 и ($pageCount-1). Поскольку $pageCount зависит от правильного значения $totalCount, которое может быть недоступно в некоторых случаях (например, MongoDB), вы можете установить это свойство в false, чтобы отключить проверку номера страницы. Сделав это, $page вернёт значение, указанное по индексу $pageParam в $params.

public boolean $validatePage = true

Подробное описание методов