Пагинатор

класс Paginator расширяет AbstractPaginator и реализует Arrayable, ArrayAccess, Countable, IteratorAggregate, Jsonable, JsonSerializable, Paginator (View source)

Трейты

ForwardsCalls

Свойства

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
int	$onEachSide	Количество ссылок, отображаемых по обе стороны от ссылки текущей страницы.	из AbstractPaginator
protected array	$options	Параметры пагинации.	из AbstractPaginator
static protected Closure	$currentPathResolver	Обратный вызов для определения текущего пути.	из AbstractPaginator
static protected Closure	$currentPageResolver	Обратный вызов для определения текущей страницы.	из AbstractPaginator
static protected Closure	$queryStringResolver	Обратный вызов для определения строки запроса.	из AbstractPaginator
static protected Closure	$viewFactoryResolver	Обратный вызов для определения фабрики представления.	из AbstractPaginator
static string	$defaultView	Представление по умолчанию для пагинации.	из AbstractPaginator
static string	$defaultSimpleView	Представление по умолчанию для "простой" пагинации.	из AbstractPaginator
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	withQueryString() Добавить все текущие значения строки запроса к пагинатору.	from AbstractPaginator
$this	addQuery(string $key, string $value) Добавить значение строки запроса к пагинатору.	from AbstractPaginator
string	buildFragment() Создать полную часть фрагмента URL.	from AbstractPaginator
$this	loadMorph(string $relation, array $relations) Загрузить набор отношений к смешанной коллекции отношений.	from AbstractPaginator
$this	loadMorphCount(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 void	queryStringResolver(Closure $resolver) Установить обратный вызов для обработки запроса по строке запроса.	from AbstractPaginator
static Factory	viewFactory() Получить экземпляр фабрики представлений из резолвера.	from AbstractPaginator
static void	viewFactoryResolver(Closure $resolver) Установить обратный вызов для резолвера фабрики представлений.	from AbstractPaginator
static void	defaultView(string $view) Установить представление по умолчанию для пагинации.	from AbstractPaginator
static void	defaultSimpleView(string $view) Установить представление по умолчанию для "простого" пагинатора.	from AbstractPaginator
static void	useTailwind() Указать, что для сгенерированных ссылок необходимо использовать стили Tailwind.	from AbstractPaginator
static void	useBootstrapThree() Указать, что для сгенерированных ссылок необходимо использовать стили Bootstrap 3.	from AbstractPaginator
ArrayIterator	getIterator() Получить итератор для элементов.	from AbstractPaginator
bool	isEmpty() Определить, пуст ли список элементов.	from AbstractPaginator
bool	isNotEmpty() Определить, не пуст ли список элементов.	from AbstractPaginator
int	count() Получить количество элементов на текущей странице.	from AbstractPaginator
Collection	getCollection() Получить базовый набор элементов пагинатора.	from AbstractPaginator
$this	setCollection(Collection $collection) Установить базовый набор элементов пагинатора.	from AbstractPaginator
array	getOptions() Получить опции пагинатора.	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) Удалить элемент по заданному ключу.	from AbstractPaginator
string	toHtml() Вывести содержимое пагинатора в HTML.	from AbstractPaginator
mixed	__call(string $method, array $parameters) Вызвать динамический метод коллекции.	from AbstractPaginator
string	__toString() Вывести содержимое пагинатора при приведении к строке.	from 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.

Details

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

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

Parameters

mixed	$object
string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

static protected void throwBadMethodCallException(string $method)

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

Parameters

string

$method

Return Value

void

Exceptions

BadMethodCallException

protected bool isValidPageNumber(int $page)

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

Parameters

int

$page

Return Value

bool

string|null previousPageUrl()

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

Return Value

string|null

array getUrlRange(int $start, int $end)

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

Parameters

int	$start
int	$end

Return Value

array

string url(int $page)

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

Parameters

int

$page

Return Value

string

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

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

Parameters

string|null

$fragment

Return Value

$this|string|null

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

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

Parameters

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

Return Value

$this

protected $this appendArray(array $keys)

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

Parameters

array

$keys

Return Value

$this

$this withQueryString()

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

Return Value

$this

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

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

Parameters

string	$key
string	$value

Return Value

$this

protected string buildFragment()

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

Return Value

string

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

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

Parameters

string	$relation
array	$relations

Return Value

$this

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

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

Parameters

string	$relation
array	$relations

Return Value

$this

array items()

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

Return Value

array

int firstItem()

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

Return Value

int

int lastItem()

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

Return Value

int

int perPage()

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

Return Value

int

bool hasPages()

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

Return Value

bool

bool onFirstPage()

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

Return Value

bool

int currentPage()

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

Return Value

int

string getPageName()

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

Return Value

string

$this setPageName(string $name)

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

Parameters

string

$name

Return Value

$this

$this withPath(string $path)

Установить базовый путь, который нужно назначить всем URL-адресам.

Parameters

string

$path

Return Value

$this

$this setPath(string $path)

Установить базовый путь, который нужно назначить всем URL-адресам.

Parameters

string

$path

Return Value

$this

$this onEachSide(int $count)

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

Parameters

int

$count

Return Value

$this

string|null path()

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

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

string|null

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 queryStringResolver(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 useTailwind()

Указать, что для сгенерированных ссылок необходимо использовать стили Tailwind.

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

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

строка toHtml()

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

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

строка

смешанный тип __call(строка $method, массив $parameters)

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

Параметры

строка	$method
массив	$parameters

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

смешанный тип

строка __toString()

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

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

строка

пустое значение __construct(смешанный тип $items, целое число $perPage, целое число|null $currentPage = null, массив $options = [])

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

Параметры

смешанный тип	$items
целое число	$perPage
целое число\|null	$currentPage
массив	$options	(путь, запрос, фрагмент, имя_страницы)

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

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

защищённый целое число setCurrentPage(целое число $currentPage)

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

Параметры

целое число

$currentPage

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

целое число

защищённый пустое значение setItems(смешанный тип $items)

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

Параметры

смешанный тип

$items

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

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

строка|null nextPageUrl()

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

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

строка|null

строка links(строка|null $view = null, массив $data = [])

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

Параметры

строка\|null	$view
массив	$data

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

строка

строка render(строка|null $view = null, массив $data = [])

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

Параметры

строка\|null	$view
массив	$data

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

строка

$this hasMorePagesWhen(логическое значение $hasMore = true)

Вручную указать, что у пагинатора есть ещё страницы.

Параметры

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

$hasMore

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

$this

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

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

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

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

массив toArray()

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

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

массив

массив jsonSerialize()

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

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

массив

строка toJson(целое число $options = 0)

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

Параметры

целое число

$options

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

строка

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