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) Передать вызов метода заданному объекту.	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\|null	firstItem() Получить номер первого элемента в срезе.	из AbstractPaginator
int\|null	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

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

$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 для предыдущей страницы.

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)

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

Параметры

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

строка getPageName()

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

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

строка

$this setPageName(строка $name)

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

Параметры

строка

$name

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

$this

$this withPath(строка $path)

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

Параметры

строка

$path

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

$this

$this setPath(строка $path)

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

Параметры

строка

$path

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

$this

$this onEachSide(целое число $count)

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

Параметры

целое число

$count

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

$this

строка|null path()

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

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

строка|null

статический строка resolveCurrentPath(строка $default = '/')

Разрешить текущий путь запроса или вернуть значение по умолчанию.

Параметры

строка

$default

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

строка

статический пусто currentPathResolver(Closure $resolver)

Установить обратный вызов для разрешения текущего пути запроса.

Параметры

Closure

$resolver

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

пусто

статический целое число resolveCurrentPage(строка $pageName = 'page', целое число $default = 1)

Разрешить текущую страницу или вернуть значение по умолчанию.

Параметры

строка	$pageName
целое число	$default

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

целое число

статический пусто currentPageResolver(Closure $resolver)

Установить обратный вызов для разрешения текущей страницы.

Параметры

Closure

$resolver

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

пусто

статический строка resolveQueryString(строка|массив|null $default = null)

Разрешить строку запроса или вернуть значение по умолчанию.

Параметры

строка|массив|null

$default

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

строка

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 $total, int $perPage, int|null $currentPage = null, array $options = [])

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

Parameters

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

Return Value

void

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

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

Parameters

int	$currentPage
string	$pageName

Return Value

int

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

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

Parameters

string\|null	$view
array	$data

Return Value

Htmlable

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

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

Parameters

string\|null	$view
array	$data

Return Value

string

Collection linkCollection()

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

Return Value

Collection

protected array elements()

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

Return Value

array

int total()

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

Return Value

int

bool hasMorePages()

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

Return Value

bool

string|null nextPageUrl()

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

Return Value

string|null

int lastPage()

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

Return Value

int

toArray()

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

array jsonSerialize()

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

Return Value

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