LengthAwarePaginator

class LengthAwarePaginator extends AbstractPaginator implements Arrayable, ArrayAccess, Countable, IteratorAggregate, Jsonable, JsonSerializable, LengthAwarePaginator (View source)

Свойства

ForwardsCalls

Tappable

Свойства

protected Collection	$items	Все элементы, которые постраничиваются.	from AbstractPaginator
protected int	$perPage	Количество элементов на странице.	from AbstractPaginator
protected int	$currentPage	Текущая просматриваемая страница.	from AbstractPaginator
protected string	$path	Базовый путь для всех URL.	from AbstractPaginator
protected array	$query	Параметры запроса для добавления во все URL.	from AbstractPaginator
protected string\|null	$fragment	Фрагмент URL для добавления во все URL.	from AbstractPaginator
protected string	$pageName	Переменная строки запроса, используемая для хранения страницы.	from AbstractPaginator
int	$onEachSide	Количество ссылок для отображения по обе стороны от ссылки текущей страницы.	from AbstractPaginator
protected array	$options	Параметры постраничного отображения.	from AbstractPaginator
static protected Closure	$currentPathResolver	Обратный вызов для определения текущего пути.	from AbstractPaginator
static protected Closure	$currentPageResolver	Обратный вызов для определения текущей страницы.	from AbstractPaginator
static protected Closure	$queryStringResolver	Обратный вызов для определения строки запроса.	from AbstractPaginator
static protected Closure	$viewFactoryResolver	Обратный вызов для определения фабрики представления.	from AbstractPaginator
static string	$defaultView	Предпочтительное представление постраничного отображения.	from AbstractPaginator
static string	$defaultSimpleView	Предпочтительное представление "простого" постраничного отображения.	from 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-адресов постраничной навигации.	from AbstractPaginator

статический строка	resolveCurrentPath(строка $default = '/') Определите текущий путь запроса или верните значение по умолчанию.	из AbstractPaginator
статический void	currentPathResolver(Closure $resolver) Установите обратный вызов определения текущего пути запроса.	из AbstractPaginator
статический целое число	resolveCurrentPage(строка $pageName = 'page', целое число $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
целое число	count() Получить количество элементов для текущей страницы.	из AbstractPaginator
Collection	getCollection() Получить базовую коллекцию пагинатора.	из AbstractPaginator
$this	setCollection(Collection $collection) Установить базовую коллекцию пагинатора.	из AbstractPaginator
массив	getOptions() Получить параметры пагинатора.	из AbstractPaginator
bool	offsetExists(смешанный $key) Определить, существует ли данный элемент.	из AbstractPaginator
смешанный	offsetGet(смешанный $key) Получить элемент по указанному смещению.	из AbstractPaginator
void	offsetSet(смешанный $key, смешанный $value) Установить элемент по указанному смещению.	из AbstractPaginator
void	offsetUnset(смешанный $key) Удалить элемент по заданному ключу.	из AbstractPaginator
строка	toHtml() Вывести содержимое пагинатора в HTML.	из AbstractPaginator
смешанный	__call(строка $method, массив $parameters) Выполнить динамические вызовы в коллекцию.	из AbstractPaginator
строка	__toString() Вывести содержимое пагинатора при приведении к строке.	из AbstractPaginator
void	__construct(смешанный $items, целое число $total, целое число $perPage, целое число\|null $currentPage = null, массив $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() Получить последнюю страницу.
toArray() Получить экземпляр в виде массива.
array	jsonSerialize() Преобразовать объект в сериализуемое в JSON представление.
string	toJson(int $options = 0) Преобразовать объект в его JSON-представление.

Details

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

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

Parameters

mixed	$object
string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

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

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

Parameters

mixed	$object
string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

static protected void throwBadMethodCallException(string $method)

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

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)

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

Parameters

string	$key
string	$value

Return Value

$this

protected string buildFragment()

Собрать полную фрагментную часть URL.

Return Value

string

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

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

Parameters

string	$relation
array	$relations

Return Value

$this

END_OF_DOCUMENT_MARKER

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

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

Параметры

string	$relation
array	$relations

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

$this

array items()

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

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

array

int firstItem()

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

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

int

int lastItem()

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

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

int

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

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

Parameters

string

$view

Return Value

void

static void defaultSimpleView(string $view)

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

Parameters

string

$view

Return Value

void

static void useTailwind()

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

Return Value

void

static void useBootstrap()

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

Return Value

void

static void useBootstrapThree()

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

Return Value

void

static void useBootstrapFour()

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

Return Value

void

static void useBootstrapFive()

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

Return Value

void

Traversable getIterator()

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

Return Value

Traversable

bool isEmpty()

Определить, пуст ли список элементов.

Return Value

bool

bool isNotEmpty()

Определить, не пуст ли список элементов.

Return Value

bool

int count()

Получить количество элементов для текущей страницы.

Return Value

int

Collection getCollection()

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

Return Value

Collection

$this setCollection(Collection $collection)

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

Parameters

Collection

$collection

Return Value

$this

array getOptions()

Получить опции пагинатора.

Return Value

array

bool offsetExists(mixed $key)

Определить, существует ли заданный элемент.

Parameters

mixed

$key

Return Value

bool

mixed offsetGet(mixed $key)

Получить элемент по заданному смещению.

Parameters

mixed

$key

Return Value

mixed

void offsetSet(mixed $key, mixed $value)

Установить элемент по заданному смещению.

Parameters

mixed	$key
mixed	$value

Return Value

void

void offsetUnset(mixed $key)

Удалить элемент по заданному ключу.

Parameters

mixed

$key

Return Value

void

string toHtml()

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

Return Value

string

mixed __call(string $method, array $parameters)

Вызвать динамические методы в коллекции.

Parameters

string	$method
array	$parameters

Return Value

mixed

string __toString()

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

Return Value

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 = [])

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

Параметры

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/9.x/Illuminate/Pagination/LengthAwarePaginator.html