Пагинатор

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

Трейты

ForwardsCalls

Tappable

Свойства

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

Методы

mixed	forwardCallTo(mixed $object, string $method, array $parameters) Передать вызов метода заданному объекту.	from ForwardsCalls
mixed	forwardDecoratedCallTo(mixed $object, string $method, array $parameters) Передать вызов метода заданному объекту, возвращая $this, если перенаправленный вызов вернул себя.	from ForwardsCalls
static void	throwBadMethodCallException(string $method) Выбросить исключение для вызова несуществующего метода.	from ForwardsCalls
$this\|HigherOrderTapProxy	tap(callable\|null $callback = null) Вызвать предоставленный замыкание с этим экземпляром, затем вернуть экземпляр.	from Tappable
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) Загрузить набор взаимосвязей в коллекцию смешанных взаимосвязей.	из AbstractPaginator
$this	loadMorphCount(string $relation, array $relations) Загрузить набор подсчётов взаимосвязей в коллекцию смешанных взаимосвязей.	из AbstractPaginator
array	items() Получить срез элементов, подлежащих постраничному отображению.	из AbstractPaginator
int	firstItem() Получить номер первого элемента в срезе.	из AbstractPaginator
int	lastItem() Получить номер последнего элемента в срезе.	из AbstractPaginator
$this	through(callable $callback) Преобразовать каждый элемент в срезе элементов с помощью обратного вызова.	из AbstractPaginator
int	perPage() Получить количество элементов на странице.	из AbstractPaginator
bool	hasPages() Определить, достаточно ли элементов для разделения на несколько страниц.	из AbstractPaginator
bool	onFirstPage() Определить, находится ли пагинатор на первой странице.	из AbstractPaginator
bool	onLastPage() Определить, находится ли пагинатор на последней странице.	из AbstractPaginator
int	currentPage() Получить текущую страницу.	из AbstractPaginator
string	getPageName() Получить имя переменной строки запроса, используемой для хранения страницы.	из AbstractPaginator
$this	setPageName(string $name) Установить имя переменной строки запроса, используемой для хранения страницы.	из AbstractPaginator
$this	withPath(string $path) Установить базовый путь, который будет назначен всем URL-адресам.	из AbstractPaginator
$this	setPath(string $path) Установить базовый путь, который будет назначен всем URL-адресам.	из AbstractPaginator
$this	onEachSide(int $count) Установить количество ссылок для отображения по обе стороны от ссылки на текущую страницу.	из AbstractPaginator

string\|null	path() Получить базовый путь для сгенерированных URL-адресов пагинатора.	из 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 string	resolveQueryString(string\|array\|null $default = null) Получить строку запроса или вернуть значение по умолчанию.	из AbstractPaginator
static void	queryStringResolver(Closure $resolver) Установить обратный вызов для определения строки запроса.	из AbstractPaginator
static Factory	viewFactory() Получить экземпляр фабрики представлений из резолвера.	из AbstractPaginator
static void	viewFactoryResolver(Closure $resolver) Установить обратный вызов для определения фабрики представлений.	из AbstractPaginator
static void	defaultView(string $view) Установить представление по умолчанию для пагинации.	из AbstractPaginator
static void	defaultSimpleView(string $view) Установить представление по умолчанию для "простого" пагинатора.	из AbstractPaginator
static void	useTailwind() Указать, что для сгенерированных ссылок следует использовать стили Tailwind.	из AbstractPaginator
static void	useBootstrap() Указать, что для сгенерированных ссылок следует использовать стили Bootstrap 4.	из 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.

Details

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

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

Parameters

mixed	$object
string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

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

Перенаправить вызов метода к заданному объекту, вернув $this, если перенаправленный вызов вернул себя.

Parameters

mixed	$object
string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

static protected void throwBadMethodCallException(string $method)

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

Parameters

string

$method

Return Value

void

Exceptions

BadMethodCallException

$this|HigherOrderTapProxy tap(callable|null $callback = null)

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

Parameters

callable|null

$callback

Return Value

$this|HigherOrderTapProxy

protected bool isValidPageNumber(int $page)

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

Parameters

int

$page

Return Value

bool

string|null previousPageUrl()

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

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

string|null

array getUrlRange(int $start, int $end)

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

Параметры

int	$start
int	$end

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

array

string url(int $page)

Получить URL для указанной страницы.

Параметры

int

$page

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

string

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

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

Параметры

string|null

$fragment

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

$this|string|null

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

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

Параметры

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

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

$this

protected $this appendArray(array $keys)

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

Параметры

array

$keys

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

$this

$this withQueryString()

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

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

$this

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

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

Параметры

string	$key
string	$value

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

$this

protected string buildFragment()

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

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

string

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

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

Параметры

string	$relation
array	$relations

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

$this

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

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

Параметры

string	$relation
array	$relations

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

$this

array items()

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

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

array

int firstItem()

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

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

int

int lastItem()

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

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

int

$this through(callable $callback)

Преобразовать каждый элемент в слайсе элементов с помощью обратного вызова.

Параметры

callable

$callback

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

$this

int perPage()

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

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

int

bool hasPages()

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

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

bool

bool onFirstPage()

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

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

bool

bool onLastPage()

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

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

bool

int currentPage()

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

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

int

string getPageName()

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

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

string

$this setPageName(string $name)

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

Параметры

string

$name

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

$this

$this withPath(string $path)

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

Параметры

string

$path

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

$this

$this setPath(string $path)

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

Параметры

string

$path

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

$this

$this onEachSide(int $count)

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

Параметры

int

$count

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

$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 string resolveQueryString(string|array|null $default = null)

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

Параметры

string|array|null

$default

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

string

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 useBootstrap()

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

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

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/8.x/Illuminate/Pagination/Paginator.html