Пагинатор

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

Свойства

ForwardsCalls

Свойства

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

Методы

mixed	forwardCallTo(mixed $object, string $method, array $parameters) Переадресация вызова метода на заданный объект.	from ForwardsCalls
static void	throwBadMethodCallException(string $method) Выбросить исключение о неправильном вызове метода для заданного метода.	from ForwardsCalls
bool	isValidPageNumber(int $page) Определить, является ли заданное значение допустимым номером страницы.	from AbstractPaginator
string\|null	previousPageUrl() Получить URL предыдущей страницы.	from AbstractPaginator
array	getUrlRange(int $start, int $end) Создать диапазон URL-адресов постраничной навигации.	from AbstractPaginator
string	url(int $page) Получить URL для заданного номера страницы.	from AbstractPaginator
$this\|string\|null	fragment(string\|null $fragment = null) Получить/установить фрагмент URL, который будет добавлен к URL-адресам.	from AbstractPaginator
$this	appends(array\|string\|null $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
$this	loadMorph(string $relation, array $relations) Загрузить набор отношений в смешанную коллекцию отношений.	from AbstractPaginator
array	items() Получить фрагмент элементов, которые разделяются на страницы.	from AbstractPaginator
int	firstItem() Получить номер первого элемента во фрагменте.	from AbstractPaginator
int	lastItem() Получить номер последнего элемента во фрагменте.	from AbstractPaginator
int	perPage() Получить количество элементов, отображаемых на одной странице.	from AbstractPaginator
bool	hasPages() Определить, достаточно ли элементов для разделения на несколько страниц.	from AbstractPaginator
bool	onFirstPage() Определить, находится ли постраничная навигация на первой странице.	from AbstractPaginator
int	currentPage() Получить текущую страницу.	from AbstractPaginator
string	getPageName() Получить переменную строки запроса, используемую для хранения страницы.	from AbstractPaginator
$this	setPageName(string $name) Установить переменную строки запроса, используемую для хранения страницы.	from AbstractPaginator
$this	withPath(string $path) Установить базовый путь для присвоения всем URL-адресам.	from AbstractPaginator
$this	setPath(string $path) Установить базовый путь для присвоения всем URL-адресам.	from AbstractPaginator
$this	onEachSide(int $count) Установить количество ссылок для отображения с каждой стороны ссылки текущей страницы.	from AbstractPaginator
string\|null	path() Получить базовый путь для сгенерированных URL-адресов постраничной навигации.	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 Factory	viewFactory() Получить экземпляр фабрики представлений от решателя.	from AbstractPaginator
static void	viewFactoryResolver(Closure $resolver) Установить обратный вызов решателя фабрики представлений.	from AbstractPaginator

static void	defaultView(string $view) Установить представление по умолчанию для пагинации.	из AbstractPaginator
static void	defaultSimpleView(string $view) Установить представление по умолчанию для "простого" пагинатора.	из AbstractPaginator
static void	useBootstrapThree() Указать, что для сгенерированных ссылок должен использоваться стиль Bootstrap 3.	из AbstractPaginator
ArrayIterator	getIterator() Получить итератор для элементов.	из AbstractPaginator
bool	isEmpty() Определить, пуст ли список элементов.	из AbstractPaginator
bool	isNotEmpty() Определить, не пуст ли список элементов.	из AbstractPaginator
int	count() Получить количество элементов на текущей странице.	из AbstractPaginator
Collection	getCollection() Получить базовый набор элементов пагинатора.	из AbstractPaginator
$this	setCollection(Collection $collection) Установить базовый набор элементов пагинатора.	из AbstractPaginator
array	getOptions() Получить опции пагинатора.	из AbstractPaginator
bool	offsetExists(mixed $key) Определить, существует ли данный элемент.	из AbstractPaginator
mixed	offsetGet(mixed $key) Получить элемент по заданному смещению.	из AbstractPaginator
void	offsetSet(mixed $key, mixed $value) Установить элемент по заданному смещению.	из 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	setItems(mixed $items) Установить элементы для пагинатора.
string\|null	nextPageUrl() Получить URL следующей страницы.
string	links(string\|null $view = null, array $data = []) Отобразить пагинатор с использованием заданного представления.
string	render(string\|null $view = null, array $data = []) Отобразить пагинатор с использованием заданного представления.
$this	hasMorePagesWhen(bool $hasMore = true) Вручную указать, что у пагинатора есть дополнительные страницы.
bool	hasMorePages() Определить, есть ли дополнительные элементы в источнике данных.
array	toArray() Получить экземпляр в виде массива.
array	jsonSerialize() Преобразовать объект в сериализуемый в JSON формат.
string	toJson(int $options = 0) Преобразовать объект в его представление в формате JSON.

Подробности

protected mixed forwardCallTo(mixed $object, string $method, array $parameters)

Перенаправить вызов метода на заданный объект.

Параметры

mixed	$object
string	$method
array	$parameters

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

mixed

Исключения

BadMethodCallException

static protected void throwBadMethodCallException(string $method)

Выбросить исключение BadMethodCallException для данного метода.

Параметры

string

$method

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

void

Исключения

BadMethodCallException

protected bool isValidPageNumber(int $page)

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

Параметры

int

$page

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

bool

string|null previousPageUrl()

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

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

string|null

END_OF_DOCUMENT_MARKER

массив getUrlRange(int $start, int $end)

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

Параметры

int	$start
int	$end

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

массив

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

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

Параметры

int

$page

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

строка

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

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

Параметры

строка|null

$fragment

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

$this|строка|null

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

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

Параметры

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

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

$this

protected $this appendArray(array $keys)

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

Параметры

массив

$keys

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

$this

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

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

Параметры

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

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

$this

protected строка buildFragment()

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

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

строка

$this loadMorph(string $relation, array $relations)

Загрузить набор отношений в коллекцию смешанных отношений.

Параметры

строка	$relation
массив	$relations

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

$this

массив items()

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

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

массив

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

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

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

целое число

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

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

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

целое число

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

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

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

целое число

логическое значение hasPages()

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

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

логическое значение

логическое значение onFirstPage()

Определить, находится ли пагинатор на первой странице.

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

логическое значение

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

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

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

целое число

строка getPageName()

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

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

строка

$this setPageName(string $name)

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

Параметры

строка

$name

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

$this

$this withPath(string $path)

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

Параметры

строка

$path

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

$this

$this setPath(string $path)

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

Параметры

строка

$path

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

$this

$this onEachSide(int $count)

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

Параметры

целое число

$count

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

$this

строка|null path()

Получить базовый путь для сгенерированных URL-адресов пагинатора.

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

строка|null

статический строка resolveCurrentPath(string $default = '/')

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

Параметры

строка

$default

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

строка

статический пустое значение currentPathResolver(Closure $resolver)

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

Параметры

Closure

$resolver

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

пустое значение

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

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

Параметры

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

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

целое число

static void currentPageResolver(Closure $resolver)

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

Параметры

Closure

$resolver

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

void

static Factory viewFactory()

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

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

Factory

static void viewFactoryResolver(Closure $resolver)

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

Параметры

Closure

$resolver

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

void

static void defaultView(string $view)

Установить представление по умолчанию для пагинации.

Параметры

string

$view

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

void

static void defaultSimpleView(string $view)

Установить представление по умолчанию для "простой" пагинации.

Параметры

string

$view

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

void

static void useBootstrapThree()

Указать, что для сгенерированных ссылок следует использовать стили Bootstrap 3.

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

void

ArrayIterator getIterator()

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

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

ArrayIterator

bool isEmpty()

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

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

bool

bool isNotEmpty()

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

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

bool

int count()

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

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

int

Collection getCollection()

Получить базовый набор пагинатора.

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

Collection

$this setCollection(Collection $collection)

Установить базовый набор пагинатора.

Параметры

Collection

$collection

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

$this

array getOptions()

Получить параметры пагинатора.

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

array

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	(путь, запрос, фрагмент, имя_страницы)

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

void

protected int setCurrentPage(int $currentPage)

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

Параметры

int

$currentPage

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

int

protected void setItems(mixed $items)

Установить элементы для пагинатора.

Параметры

mixed

$items

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

void

string|null nextPageUrl()

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

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

string|null

string links(string|null $view = null, array $data = [])

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

Параметры

string\|null	$view
array	$data

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

string

string render(string|null $view = null, array $data = [])

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

Параметры

string\|null	$view
array	$data

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

string

$this hasMorePagesWhen(bool $hasMore = true)

Ручное указание наличия дополнительных страниц разбиения на страницы.

Параметры

bool

$hasMore

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

$this

bool hasMorePages()

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

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

bool

array toArray()

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

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

array

array jsonSerialize()

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

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

array

string toJson(int $options = 0)

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

Параметры

int

$options

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

string

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