LengthAwarePaginator

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

Трейты

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 int	$total	Общее количество элементов до применения усечения.
protected int	$lastPage	Последняя доступная страница.

Методы

mixed	forwardCallTo(mixed $object, string $method, array $parameters) Перенаправить вызов метода заданному объекту.	из ForwardsCalls
mixed	forwardDecoratedCallTo(mixed $object, string $method, array $parameters) Перенаправить вызов метода заданному объекту, возвращая $this, если перенаправленный вызов вернул себя.	из ForwardsCalls
static void	throwBadMethodCallException(string $method) Выбросить исключение плохого вызова метода для заданного метода.	из ForwardsCalls
tap($callback = null) Вызвать заданный замыкание с этим экземпляром, а затем вернуть экземпляр.	из Tappable
bool	isValidPageNumber(int $page) Определить, является ли заданное значение допустимым номером страницы.	из AbstractPaginator
string\|null	previousPageUrl() Получить URL для предыдущей страницы.	из AbstractPaginator
array	getUrlRange(int $start, int $end) Создать диапазон URL-адресов постраничной навигации.	из AbstractPaginator
string	url(int $page) Получить URL для заданного номера страницы.	из AbstractPaginator
$this\|string\|null	fragment(string\|null $fragment = null) Получить/установить фрагмент URL, который будет добавлен к URL-адресам.	из AbstractPaginator
$this	appends(array\|string\|null $key, string\|null $value = null) Добавить набор значений строки запроса к постраничнику.	из AbstractPaginator
$this	appendArray(array $keys) Добавить массив значений строки запроса.	из AbstractPaginator
$this	withQueryString() Добавить все текущие значения строки запроса к постраничнику.	из AbstractPaginator
$this	addQuery(string $key, string $value) Добавить значение строки запроса к постраничнику.	из AbstractPaginator
string	buildFragment() Сгенерировать полную часть фрагмента URL.	из AbstractPaginator
$this	loadMorph(string $relation, array $relations) Загрузить набор отношений на коллекцию смешанных отношений.	из 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

static void	useBootstrapFour() Указать, что для сгенерированных ссылок следует использовать стили Bootstrap 4.	from AbstractPaginator
static void	useBootstrapFive() Указать, что для сгенерированных ссылок следует использовать стили Bootstrap 5.	from AbstractPaginator
Traversable	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

строка	__toString() Отобразить содержимое постраничной навигации при приведении к строке.	из AbstractPaginator
void	__construct(mixed $items, int $total, int $perPage, int\|null $currentPage = null, array $options = []) Создать новый экземпляр постраничной навигации.
int	setCurrentPage(int $currentPage, string $pageName) Получить текущую страницу для запроса.
Htmlable	links(string\|null $view = null, array $data = []) Отобразить постраничную навигацию с помощью заданного представления.
строка	render(string\|null $view = null, array $data = []) Отобразить постраничную навигацию с помощью заданного представления.
Collection	linkCollection() Получить ссылки на страницы постраничной навигации в виде коллекции (для ответов в формате JSON).
массив	elements() Получить массив элементов для передачи в представление.
int	total() Получить общее количество элементов, подлежащих постраничной навигации.
bool	hasMorePages() Определить, есть ли еще элементы в источнике данных.
строка\|null	nextPageUrl() Получить URL следующей страницы.
int	lastPage() Получить последнюю страницу.
toArray() Получить экземпляр в виде массива.
массив	jsonSerialize() Преобразовать объект в сериализуемый в JSON формат.
строка	toJson(int $options = 0) Преобразовать объект в его представление в формате JSON.

Подробности

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

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

Параметры

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

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

mixed

Исключения

BadMethodCallException

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

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

Параметры

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

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

mixed

Исключения

BadMethodCallException

static protected void throwBadMethodCallException(string $method)

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

Parameters

string

$method

Return Value

void

Exceptions

BadMethodCallException

tap($callback = null)

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

Parameters

$callback

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.

Значение возвращаемого значения

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

Коллекция getCollection()

Получить базовую коллекцию пагинатора.

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

Коллекция

$this setCollection(Коллекция $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 $total, int $perPage, int|null $currentPage = null, array $options = [])

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

Параметры

mixed	$items
int	$total
int	$perPage
int\|null	$currentPage
array	$options	(путь, запрос, фрагмент, имя страницы)

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

void

protected int setCurrentPage(int $currentPage, string $pageName)

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

Параметры

int	$currentPage
string	$pageName

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

int

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

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

Параметры

string\|null	$view
array	$data

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

Htmlable

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

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

Параметры

string\|null	$view
array	$data

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

string

Collection linkCollection()

Получить ссылки для страниц навигации в виде коллекции (для ответов в формате JSON).

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

Collection

protected array elements()

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

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

array

int total()

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

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

int

bool hasMorePages()

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

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

bool

string|null nextPageUrl()

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

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

string|null

int lastPage()

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

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

int

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/LengthAwarePaginator.html