Пагинатор

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

Трейты

ForwardsCalls

Tappable

Свойства

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

статический string	resolveCurrentPath(string $default = '/') Определить текущий путь запроса или вернуть значение по умолчанию.	из AbstractPaginator
статический void	currentPathResolver(Closure $resolver) Установить обратный вызов для определения текущего пути запроса.	из AbstractPaginator
статический int	resolveCurrentPage(string $pageName = 'page', int $default = 1) Определить текущую страницу или вернуть значение по умолчанию.	из AbstractPaginator
статический void	currentPageResolver(Closure $resolver) Установить обратный вызов для определения текущей страницы.	из AbstractPaginator
статический string	resolveQueryString(string\|array\|null $default = null) Определить строку запроса или вернуть значение по умолчанию.	из AbstractPaginator
статический void	queryStringResolver(Closure $resolver) Установить обратный вызов для определения строки запроса.	из AbstractPaginator
статический Factory	viewFactory() Получить экземпляр фабрики представлений из решателя.	из AbstractPaginator
статический void	viewFactoryResolver(Closure $resolver) Установить обратный вызов для решателя фабрики представлений.	из AbstractPaginator
статический void	defaultView(string $view) Установить представление по умолчанию для пагинации.	из AbstractPaginator
статический void	defaultSimpleView(string $view) Установить представление по умолчанию для "простой" пагинации.	из AbstractPaginator
статический void	useTailwind() Указать, что для сгенерированных ссылок следует использовать стили Tailwind.	из AbstractPaginator
статический void	useBootstrap() Указать, что для сгенерированных ссылок следует использовать стили Bootstrap 4.	из AbstractPaginator
статический void	useBootstrapThree() Указать, что для сгенерированных ссылок следует использовать стили Bootstrap 3.	из AbstractPaginator
статический void	useBootstrapFour() Указать, что для сгенерированных ссылок следует использовать стили Bootstrap 4.	из AbstractPaginator
статический void	useBootstrapFive() Указать, что для сгенерированных ссылок следует использовать стили Bootstrap 5.	из AbstractPaginator
Traversable	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() Определить, есть ли дополнительные элементы в источнике данных.
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

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

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

Параметры

mixed	$object
string	$method
array	$parameters

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

mixed

Исключения

BadMethodCallException

static protected void throwBadMethodCallException(string $method)

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

Параметры

string

$method

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

void

Исключения

BadMethodCallException

tap($callback = null)

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

Параметры

$callback

protected bool isValidPageNumber(int $page)

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

Параметры

int

$page

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

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|null firstItem()

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

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

int|null

int|null lastItem()

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

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

int|null

$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

static void useBootstrapFour()

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

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

void

static void useBootstrapFive()

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

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

void

Traversable getIterator()

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

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

Traversable

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

toArray()

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

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