Пагинатор

класс Paginator реализует ArrayableInterface, ArrayAccess, Countable, IteratorAggregate, JsonableInterface (Просмотреть исходный код)

Свойства

protected Factory	$factory	Фабрика пагинации.
protected array	$items	Элементы, подлежащие пагинации.
protected int	$total	Общее количество элементов.
protected bool	$hasMore	Указывает, есть ли дополнительные элементы при "быстрой" пагинации.
protected int	$perPage	Количество элементов на странице.
protected int	$currentPage	Получить текущую страницу для запроса.
protected	$lastPage	Получить последний номер страницы.
protected int	$from	Номер первого элемента в этом диапазоне.
protected int	$to	Номер последнего элемента в этом диапазоне.
protected array	$query	Все дополнительные значения строки запроса.
protected string	$fragment	Фрагмент, который должен быть добавлен ко всем URL.

Методы

void

__construct(Factory $factory, array $items, int $total, int|null $perPage = null)

Создать новый экземпляр Paginator.

$this

setupPaginationContext()

Настроить контекст постраничной навигации (текущая и последняя страницы).

void

calculateCurrentAndLastPages()

Вычислить текущую и последнюю страницы для данного экземпляра.

void

calculateItemRanges()

Вычислить номера первой и последней записи для этого экземпляра.

int

calculateCurrentPage(int $lastPage)

Получить текущую страницу для запроса.

bool

isValidPageNumber(int $page)

Определить, является ли данное значение допустимым номером страницы.

View

links(string $view = null)

Получить представление ссылок для постраничной навигации.

string

getUrl(int $page)

Получить URL для заданного номера страницы.

$this|string

fragment(string|null $fragment = null)

Получить/установить фрагмент URL, который будет добавлен к URL-адресам.

string

buildFragment()

Собрать полную фрагментную часть URL.

$this

appends(string $key, string $value = null)

Добавить значение параметра запроса в Paginator.

$this

appendArray(array $keys)

Добавить массив значений параметров запроса.

$this

addQuery(string $key, string $value)

Добавить значение параметра запроса в Paginator.

bool

isQuickPaginating()

Определить, использует ли Paginator "быструю" постраничную навигацию.

int

getCurrentPage(int|null $total = null)

Получить текущую страницу для запроса.

int

getLastPage()

Получить последнюю доступную страницу.

int

getFrom()

Получить номер первой записи в Paginator.

int

getTo()

Получить номер последней записи в Paginator.

int

getPerPage()

Получить количество записей на странице.

Collection

getCollection()

Получить экземпляр коллекции, содержащий элементы.

array

getItems()

Получить элементы, которые подвергаются постраничной навигации.

void

setItems(mixed $items)

Установить элементы, которые подвергаются постраничной навигации.

int

getTotal()

Получить общее количество элементов в коллекции.

void

setBaseUrl(string $baseUrl)

Установить базовый URL, используемый Paginator.

Factory

getFactory()

Получить фабрику постраничной навигации.

ArrayIterator

getIterator()

Получить итератор для элементов.

bool

isEmpty()

Определить, пустой ли список элементов.

int

count()

Получить количество элементов для текущей страницы.

bool

offsetExists(mixed $key)

Определить, существует ли данный элемент.

mixed

offsetGet(mixed $key)

Получить элемент по заданному смещению.

void

offsetSet(mixed $key, mixed $value)

Установить элемент по заданному смещению.

void

offsetUnset(mixed $key)

Удалить элемент по заданному ключу.

array

toArray()

Получить экземпляр в виде массива.

string

toJson(int $options)

Преобразовать объект в его JSON-представление.

mixed

__call(string $method, array $arguments)

Вызвать метод на базовой коллекции

Подробности

void __construct(Factory $factory, array $items, int $total, int|null $perPage = null)

Создать новый экземпляр Paginator.

Параметры

Factory	$factory
array	$items
int	$total
int\|null	$perPage

Возвращаемое значение

void

$this setupPaginationContext()

Настройка контекста постраничной навигации (текущая и последняя страницы).

Значение возврата

$this

protected void calculateCurrentAndLastPages()

Вычисление текущей и последней страниц для этого экземпляра.

Значение возврата

void

protected void calculateItemRanges()

Вычисление начального и конечного номера элементов для этого экземпляра.

Значение возврата

void

protected int calculateCurrentPage(int $lastPage)

Получение текущей страницы для запроса.

Параметры

int

$lastPage

Значение возврата

int

protected bool isValidPageNumber(int $page)

Определение, является ли заданное значение допустимым номером страницы.

Параметры

int

$page

Значение возврата

bool

View links(string $view = null)

Получение представления ссылок для постраничной навигации.

Параметры

string

$view

Значение возврата

View

string getUrl(int $page)

Получение URL для указанного номера страницы.

Параметры

int

$page

Значение возврата

string

$this|string fragment(string|null $fragment = null)

Получение/установка фрагмента URL, который будет добавлен к URL.

Параметры

string|null

$fragment

Значение возврата

$this|string

protected string buildFragment()

Построение полной части фрагмента URL.

Значение возврата

string

$this appends(string $key, string $value = null)

Добавление значения строки запроса к постраничному навигатору.

Параметры

string	$key
string	$value

Значение возврата

$this

protected $this appendArray(array $keys)

Добавление массива значений строки запроса.

Параметры

array

$keys

Значение возврата

$this

$this addQuery(string $key, string $value)

Добавление значения строки запроса к постраничному навигатору.

Параметры

string	$key
string	$value

Значение возврата

$this

bool isQuickPaginating()

Определить, выполняет ли постраничный навигатор "быструю" постраничную навигацию.

Значение возврата

bool

int getCurrentPage(int|null $total = null)

Получение текущей страницы для запроса.

Параметры

int|null

$total

Значение возврата

int

int getLastPage()

Получение последней доступной страницы.

Значение возврата

int

int getFrom()

Получение номера первого элемента в постраничном навигаторе.

Значение возврата

int

int getTo()

Получение номера последнего элемента в постраничном навигаторе.

Значение возврата

int

int getPerPage()

Получение количества элементов, отображаемых на странице.

Значение возврата

int

Collection getCollection()

Получение экземпляра коллекции, содержащей элементы.

Значение возврата

Collection

array getItems()

Получение элементов, подлежащих постраничной навигации.

Значение возврата

array

void setItems(mixed $items)

Установить элементы, подлежащие постраничной навигации.

Параметры

mixed

$items

Значение возврата

void

int getTotal()

Получение общего количества элементов в коллекции.

Значение возврата

int

void setBaseUrl(string $baseUrl)

Установить базовый URL, используемый постраничным навигатором.

Параметры

string

$baseUrl

Значение возврата

void

Factory getFactory()

Получение фабрики постраничной навигации.

Значение возврата

Factory

ArrayIterator getIterator()

Получение итератора для элементов.

Значение возврата

ArrayIterator

bool isEmpty()

Определить, пуст ли список элементов.

Значение возврата

bool

int count()

Получить количество элементов для текущей страницы.

Значение возврата

int

bool offsetExists(mixed $key)

Определить, существует ли заданный элемент.

Параметры

mixed

$key

Значение возврата

bool

mixed offsetGet(mixed $key)

Получить элемент по заданному смещению.

Параметры

mixed

$key

Значение возврата

mixed

void offsetSet(mixed $key, mixed $value)

Установить элемент по заданному смещению.

Параметры

mixed	$key
mixed	$value

Значение возврата

void

void offsetUnset(mixed $key)

Удалить элемент по заданному ключу.

Параметры

mixed

$key

Значение возврата

void

array toArray()

Получить экземпляр в виде массива.

Значение возврата

array

string toJson(int $options)

Преобразовать объект в его представление JSON.

Параметры

int

$options

Значение возврата

string

mixed __call(string $method, array $arguments)

Вызвать метод на базовом объекте Collection

Параметры

string	$method
array	$arguments

Значение возврата

mixed

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/4.2/Illuminate/Pagination/Paginator.html