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

класс 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
$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) Загрузить набор отношений на коллекцию смешанных отношений.	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

статический строка	resolveCurrentPath(строка $default = '/') Определить текущий путь запроса или вернуть значение по умолчанию.	из AbstractPaginator
статический void	currentPathResolver(Closure $resolver) Установить обратный вызов для определения текущего пути запроса.	из AbstractPaginator
статический int	resolveCurrentPage(строка $pageName = 'page', int $default = 1) Определить текущую страницу или вернуть значение по умолчанию.	из AbstractPaginator
статический void	currentPageResolver(Closure $resolver) Установить обратный вызов для определения текущей страницы.	из AbstractPaginator
статический строка	resolveQueryString(строка\|массив\|null $default = null) Определить строку запроса или вернуть значение по умолчанию.	из AbstractPaginator
статический void	queryStringResolver(Closure $resolver) Установить обратный вызов для определения строки запроса.	из AbstractPaginator
статический Factory	viewFactory() Получить экземпляр фабрики представлений из разрешителя.	из AbstractPaginator
статический void	viewFactoryResolver(Closure $resolver) Установить обратный вызов для разрешения фабрики представлений.	из AbstractPaginator
статический void	defaultView(строка $view) Установить представление по умолчанию для пагинации.	из AbstractPaginator
статический void	defaultSimpleView(строка $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
массив	getOptions() Получить параметры пагинатора.	из AbstractPaginator
bool	offsetExists(mixed $key) Определить, существует ли указанный элемент.	из AbstractPaginator
mixed	offsetGet(mixed $key) Получить элемент по заданному смещению.	из AbstractPaginator
void	offsetSet(mixed $key, mixed $value) Установить элемент по заданному смещению.	из AbstractPaginator
void	offsetUnset(mixed $key) Удалить элемент по заданному ключу.	из AbstractPaginator
строка	toHtml() Вывести содержимое пагинатора в HTML.	из AbstractPaginator
mixed	__call(строка $method, массив $parameters) Вызывать динамические методы коллекции.	из AbstractPaginator
строка	__toString() Вывести содержимое пагинатора при приведении к строке.	из AbstractPaginator
void	__construct(mixed $items, int $perPage, int\|null $currentPage = null, массив $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

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

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

Параметры

callable|null

$callback

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

$this|HigherOrderTapProxy

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

END_OF_DOCUMENT_MARKER

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

END_OF_DOCUMENT_MARKER

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