LengthAwarePaginator

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

Трейты

ForwardsCalls

Свойства

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
static void	throwBadMethodCallException(string $method) Выбросить исключение плохого вызова метода для данного метода.	from ForwardsCalls
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
int	perPage() Получить количество элементов на странице.	from AbstractPaginator
bool	hasPages() Определить, достаточно ли элементов для разделения на несколько страниц.	from AbstractPaginator
bool	onFirstPage() Определить, находится ли пагинатор на первой странице.	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
static string	resolveCurrentPath(string $default = '/') Разрешить текущий путь запроса или вернуть значение по умолчанию.	from AbstractPaginator
static void	currentPathResolver(Closure $resolver) Установить обратный вызов для разрешения текущего пути запроса.	from AbstractPaginator
static int	resolveCurrentPage(string $pageName = 'page', int $default = 1) Разрешить текущую страницу или вернуть значение по умолчанию.	from AbstractPaginator

static void	currentPageResolver(Closure $resolver) Установить обратный вызов для определения текущей страницы.	from AbstractPaginator
static void	queryStringResolver(Closure $resolver) Установить обратный вызов для определения параметра запроса.	from AbstractPaginator
static Factory	viewFactory() Получить экземпляр фабрики представления из резолвера.	from AbstractPaginator
static void	viewFactoryResolver(Closure $resolver) Установить обратный вызов для резолвера фабрики представления.	from AbstractPaginator
static void	defaultView(string $view) Установить представление по умолчанию для постраничной навигации.	from AbstractPaginator
static void	defaultSimpleView(string $view) Установить представление по умолчанию для "простой" постраничной навигации.	from AbstractPaginator
static void	useTailwind() Указать, что для сгенерированных ссылок следует использовать стили Tailwind.	from AbstractPaginator
static void	useBootstrapThree() Указать, что для сгенерированных ссылок следует использовать стили Bootstrap 3.	from 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

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

Подробности

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

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

Parameters

mixed	$object
string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

static protected void throwBadMethodCallException(string $method)

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

Parameters

string

$method

Return Value

void

Exceptions

BadMethodCallException

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

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

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

int

int lastItem()

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

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

int

int perPage()

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

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

int

bool hasPages()

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

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

bool

bool onFirstPage()

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

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

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 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 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

строка render(строка|null $view = null, массив $data = [])

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

Параметры

строка\|null	$view
массив	$data

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

строка

защищённый массив elements()

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

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

массив

целое число total()

Получить общее количество элементов, разбитых на страницы.

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

целое число

логическое значение hasMorePages()

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

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

логическое значение

строка|null nextPageUrl()

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

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

строка|null

целое число lastPage()

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

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

целое число

массив toArray()

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

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

массив

массив jsonSerialize()

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

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

массив

строка toJson(целое число $options = 0)

Преобразовать объект в его JSON-представление.

Параметры

целое число

$options

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

строка

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/7.x/Illuminate/Pagination/LengthAwarePaginator.html