Paginator

class Paginator extends AbstractPaginator implements Arrayable, ArrayAccess, Countable, IteratorAggregate, Jsonable, Paginator (View source)

Свойства

protected Collection	$items	Все элементы, которые подлежат постраничной навигации.	из AbstractPaginator
protected int	$perPage	Количество элементов на странице.	из AbstractPaginator
protected int	$currentPage	Текущая просматриваемая страница.	из AbstractPaginator
protected string	$path	Базовый путь для всех URL-адресов.	из AbstractPaginator
protected array	$query	Параметры запроса, добавляемые ко всем URL-адресам.	из AbstractPaginator
protected string\|null	$fragment	Фрагмент URL-адреса, добавляемый ко всем URL-адресам.	из AbstractPaginator
protected string	$pageName	Имя параметра запроса, используемого для хранения номера страницы.	из AbstractPaginator
static protected Closure	$currentPathResolver	Обратный вызов для определения текущего пути.	из AbstractPaginator
static protected Closure	$currentPageResolver	Обратный вызов для определения текущей страницы.	из AbstractPaginator
static protected Closure	$presenterResolver	Обратный вызов для определения презентера по умолчанию.	из AbstractPaginator
protected	$hasMore	Указывает, есть ли еще элементы в источнике данных.

Методы

bool	isValidPageNumber(int $page) Определить, является ли данное значение допустимым номером страницы.	из AbstractPaginator
string	getUrlRange(int $start, int $end) Создать диапазон страниц для пагинации.	из AbstractPaginator
string	url(int $page) Получить URL для заданного номера страницы.	из AbstractPaginator
string\|null	previousPageUrl() Получить URL предыдущей страницы.	из AbstractPaginator
$this\|string\|null	fragment(string\|null $fragment = null) Получить/установить фрагмент URL, который будет добавлен к URL.	из AbstractPaginator
$this	appends(array\|string $key, string\|null $value = null) Добавить набор значений параметров запроса к пагинатору.	из AbstractPaginator
$this	appendArray(array $keys) Добавить массив значений параметров запроса.	из AbstractPaginator
$this	addQuery(string $key, string $value) Добавить значение параметра запроса к пагинатору.	из AbstractPaginator
string	buildFragment() Сформировать полную фрагментную часть URL.	из AbstractPaginator
array	items() Получить срез элементов, подлежащих пагинации.	из AbstractPaginator
int	firstItem() Получить номер первого элемента в срезе.	из AbstractPaginator
int	lastItem() Получить номер последнего элемента в срезе.	из AbstractPaginator
int	perPage() Получить количество элементов на странице.	из AbstractPaginator
int	currentPage() Получить текущую страницу.	из AbstractPaginator
bool	hasPages() Определить, достаточно ли элементов, чтобы разбить их на несколько страниц.	из AbstractPaginator
static string	resolveCurrentPath(string $default = '/') Разобрать текущий путь запроса или вернуть значение по умолчанию.	из AbstractPaginator
static void	currentPathResolver(Closure $resolver) Установить обратный вызов для разбора текущего пути запроса.	из AbstractPaginator
static int	resolveCurrentPage(string $pageName = 'page', int $default = 1) Разобрать текущую страницу или вернуть значение по умолчанию.	из AbstractPaginator
static void	currentPageResolver(Closure $resolver) Установить обратный вызов для разбора текущей страницы.	из AbstractPaginator
static void	presenter(Closure $resolver) Установить обработчик по умолчанию для Presenter.	из AbstractPaginator
string	getPageName() Получить имя переменной строки запроса, используемой для хранения номера страницы.	из AbstractPaginator
$this	setPageName(string $name) Установить имя переменной строки запроса, используемой для хранения номера страницы.	из AbstractPaginator
$this	setPath(string $path) Установить базовый путь для присваивания всем URL.	из AbstractPaginator
ArrayIterator	getIterator() Получить итератор для элементов.	из AbstractPaginator
bool	isEmpty() Определить, пуст ли список элементов.	из AbstractPaginator
int	count() Получить количество элементов на текущей странице.	из AbstractPaginator
Collection	getCollection() Получить базовую коллекцию пагинатора.	из AbstractPaginator
bool	offsetExists(mixed $key) Определить, существует ли заданный элемент.	из AbstractPaginator
mixed	offsetGet(mixed $key) Получить элемент по заданному смещению.	из AbstractPaginator
void	offsetSet(mixed $key, mixed $value) Установить элемент по заданному смещению.	из AbstractPaginator
void	offsetUnset(mixed $key) Удалить элемент по заданному ключу.	из AbstractPaginator

смешанный	__call(string $method, array $parameters) Вызвать динамические методы коллекции.	из AbstractPaginator
строка	__toString() Отобразить содержимое пагинатора при приведении к строке.	из AbstractPaginator
void	__construct(mixed $items, int $perPage, int\|null $currentPage = null, array $options = []) Создать новый экземпляр пагинатора.
целое число	setCurrentPage(int $currentPage) Получить текущую страницу для запроса.
void	checkForMorePages() Проверить наличие дополнительных страниц. Последний элемент будет удален.
строка\|null	nextPageUrl() Получить URL следующей страницы.
булево	hasMorePages() Определить, есть ли дополнительные элементы в источнике данных.
строка	render(Presenter $presenter = null) Отобразить пагинатор с помощью заданного презентера.
массив	toArray() Получить экземпляр в виде массива.
строка	toJson(int $options) Преобразовать объект в его JSON-представление.

Подробности

protected булево isValidPageNumber(int $page)

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

Параметры

целое число

$page

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

булево

строка getUrlRange(int $start, int $end)

Создать диапазон URL-адресов пагинации.

Параметры

целое число	$start
целое число	$end

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

строка

строка url(int $page)

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

Параметры

целое число

$page

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

строка

строка|null previousPageUrl()

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

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

строка|null

$this|строка|null fragment(string|null $fragment = null)

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

Параметры

строка|null

$fragment

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

$this|строка|null

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

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

Параметры

массив\|строка	$key
строка\|null	$value

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

$this

protected $this appendArray(array $keys)

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

Параметры

массив

$keys

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

$this

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

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

Параметры

строка	$key
строка	$value

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

$this

protected строка buildFragment()

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

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

строка

массив items()

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

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

массив

целое число firstItem()

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

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

целое число

целое число lastItem()

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

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

целое число

целое число perPage()

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

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

целое число

целое число currentPage()

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

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

целое число

булево hasPages()

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

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

булево

static строка resolveCurrentPath(string $default = '/')

Разрешить текущий путь запроса или вернуть значение по умолчанию.

Параметры

строка

$default

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

строка

static void currentPathResolver(Closure $resolver)

Установить обратный вызов разрешения текущего пути запроса.

Параметры

Closure

$resolver

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

void

static целое число resolveCurrentPage(string $pageName = 'page', int $default = 1)

Разрешить текущую страницу или вернуть значение по умолчанию.

Параметры

строка	$pageName
целое число	$default

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

целое число

static void currentPageResolver(Closure $resolver)

Установить обратный вызов разрешения текущей страницы.

Параметры

Closure

$resolver

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

void

static void presenter(Closure $resolver)

Установите обработчик Presenter по умолчанию.

Parameters

Closure

$resolver

Return Value

void

string getPageName()

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

Return Value

string

$this setPageName(string $name)

Установить переменную строки запроса, используемую для хранения страницы.

Parameters

string

$name

Return Value

$this

$this setPath(string $path)

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

Parameters

string

$path

Return Value

$this

ArrayIterator getIterator()

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

Return Value

ArrayIterator

bool isEmpty()

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

Return Value

bool

int count()

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

Return Value

int

Collection getCollection()

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

Return Value

Collection

bool offsetExists(mixed $key)

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

Parameters

mixed

$key

Return Value

bool

mixed offsetGet(mixed $key)

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

Parameters

mixed

$key

Return Value

mixed

void offsetSet(mixed $key, mixed $value)

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

Parameters

mixed	$key
mixed	$value

Return Value

void

void offsetUnset(mixed $key)

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

Parameters

mixed

$key

Return Value

void

mixed __call(string $method, array $parameters)

Вызвать динамические методы в коллекции.

Parameters

string	$method
array	$parameters

Return Value

mixed

string __toString()

Отобразить содержимое разделителя страниц при приведении к строке.

Return Value

string

void __construct(mixed $items, int $perPage, int|null $currentPage = null, array $options = [])

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

Parameters

mixed	$items
int	$perPage
int\|null	$currentPage
array	$options	(path, query, fragment, pageName)

Return Value

void

protected int setCurrentPage(int $currentPage)

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

Parameters

int

$currentPage

Return Value

int

protected void checkForMorePages()

Проверить наличие дополнительных страниц. Последний элемент будет удален.

Return Value

void

string|null nextPageUrl()

Получить URL для следующей страницы.

Return Value

string|null

bool hasMorePages()

Определить, есть ли дополнительные элементы в источнике данных.

Return Value

bool

string render(Presenter $presenter = null)

Отобразить разделитель страниц с использованием предоставленного обработчика.

Parameters

Presenter

$presenter

Return Value

string

array toArray()

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

Return Value

array

string toJson(int $options)

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

Parameters

int

$options

Return Value

string

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