Страничный навигатор

класс Paginator расширяет AbstractPaginator и реализует Arrayable, ArrayAccess, Countable, IteratorAggregate, JsonSerializable, Jsonable, Paginator (Просмотреть исходный код)

Свойства

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

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

Подробности

protected bool isValidPageNumber(int $page)

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

Параметры

int

$page

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

bool

string getUrlRange(int $start, int $end)

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

Параметры

int	$start
int	$end

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

string

string url(int $page)

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

Параметры

int

$page

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

string

string|null previousPageUrl()

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

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

string|null

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

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

Параметры

string|null

$fragment

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

$this|string|null

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

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

Параметры

array\|string	$key
string\|null	$value

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

$this

protected $this appendArray(array $keys)

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

Параметры

array

$keys

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

$this

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

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

Параметры

string	$key
string	$value

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

$this

protected string buildFragment()

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

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

string

array items()

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

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

array

int firstItem()

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

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

int

int lastItem()

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

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

int

int perPage()

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

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

int

int currentPage()

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

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

int

bool hasPages()

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

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

bool

static string resolveCurrentPath(string $default = '/')

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

Параметры

string

$default

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

string

static void currentPathResolver(Closure $resolver)

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

Параметры

Closure

$resolver

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

void

static int resolveCurrentPage(string $pageName = 'page', int $default = 1)

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

Параметры

string	$pageName
int	$default

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

int

static void currentPageResolver(Closure $resolver)

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

Параметры

Closure

$resolver

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

void

static void presenter(Closure $resolver)

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

Параметры

Closure

$resolver

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

void

string getPageName()

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

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

string

$this setPageName(string $name)

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

Параметры

string

$name

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

$this

$this setPath(string $path)

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

Параметры

string

$path

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

$this

ArrayIterator getIterator()

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

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

ArrayIterator

bool isEmpty()

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

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

bool

int count()

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

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

int

Collection getCollection()

Получить базовую коллекцию пагинатора.

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

Collection

$this setCollection(Collection $collection)

Установить базовую коллекцию пагинатора.

Параметры

Collection

$collection

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

$this

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

string toHtml()

Отобразить содержимое пагинатора в HTML.

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

string

mixed __call(string $method, array $parameters)

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

Параметры

string	$method
array	$parameters

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

mixed

string __toString()

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

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

string

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

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

Параметры

mixed	$items
int	$perPage
int\|null	$currentPage
array	$options	(путь, запрос, фрагмент, pageName)

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

void

protected int setCurrentPage(int $currentPage)

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

Параметры

int

$currentPage

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

int

protected void checkForMorePages()

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

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

void

string|null nextPageUrl()

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

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

string|null

bool hasMorePages()

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

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

bool

string links(Presenter $presenter = null)

Отобразить разбиение на страницы с помощью заданного презентера.

Параметры

Presenter

$presenter

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

string

string render(Presenter $presenter = null)

Отобразить разбиение на страницы с помощью заданного презентера.

Параметры

Presenter

$presenter

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

string

array toArray()

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

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

array

array jsonSerialize()

Преобразовать объект в сериализуемый в JSON формат.

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

array

string toJson(int $options)

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

Параметры

int

$options

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

string

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