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) Загрузить набор отношений в коллекцию смешанных отношений.	from AbstractPaginator
$this	loadMorphCount(string $relation, array $relations) Загрузить набор подсчётов отношений в коллекцию смешанных отношений.	from AbstractPaginator
array	items() Получить часть элементов, подлежащих постраничной навигации.	from AbstractPaginator
int	firstItem() Получить номер первого элемента в части.	from AbstractPaginator
int	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-адресов пагинатора.	из 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() Получить итератор для элементов.	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
string	__toString() Вывести содержимое пагинатора при приведении к строке.	from 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 = []) Отобразить разбиение на страницы с помощью заданного представления.
string	render(string\|null $view = null, array $data = []) Отобразить разбиение на страницы с помощью заданного представления.
Collection	linkCollection() Получить ссылки для разбиения на страницы как коллекцию (для ответов в формате JSON).
array	elements() Получить массив элементов для передачи в представление.
int	total() Получить общее количество элементов, разбитых на страницы.
bool	hasMorePages() Определить, есть ли еще элементы в источнике данных.
string\|null	nextPageUrl() Получить URL следующей страницы.
int	lastPage() Получить последнюю страницу.
array	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)

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

Parameters

string	$relation
array	$relations

Return Value

$this

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

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

Parameters

string	$relation
array	$relations

Return Value

$this

array items()

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

Return Value

array

int firstItem()

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

Return Value

int

int lastItem()

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

Return Value

int

$this through(callable $callback)

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

Parameters

callable

$callback

Return Value

$this

int perPage()

Получить количество элементов на странице.

Return Value

int

bool hasPages()

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

Return Value

bool

bool onFirstPage()

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

Return Value

bool

bool onLastPage()

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

Return Value

bool

int currentPage()

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

Return Value

int

string getPageName()

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

Return Value

string

$this setPageName(string $name)

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

Parameters

string

$name

Return Value

$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

статический Factory viewFactory()

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

Значение результата

Factory

статический void viewFactoryResolver(Closure $resolver)

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

Параметры

Closure

$resolver

Значение результата

void

статический void defaultView(string $view)

Установить представление по умолчанию для пагинации.

Параметры

string

$view

Значение результата

void

статический void defaultSimpleView(string $view)

Установить представление по умолчанию "простой" пагинации.

Параметры

string

$view

Значение результата

void

статический void useTailwind()

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

Значение результата

void

статический void useBootstrap()

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

Значение результата

void

статический 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 $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

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