LengthAwarePaginator

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

Свойства

ForwardsCalls

Свойства

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	$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
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	addQuery(string $key, string $value) Добавить значение параметра запроса к пагинатору.	from AbstractPaginator
string	buildFragment() Сгенерировать полную часть фрагмента URL.	from AbstractPaginator
$this	loadMorph(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 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	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
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

строка	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 смешанный тип forwardCallTo(mixed $object, string $method, array $parameters)

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

Параметры

смешанный тип	$object
строка	$method
массив	$parameters

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

смешанный тип

Исключения

BadMethodCallException

static protected void throwBadMethodCallException(string $method)

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

Параметры

строка

$method

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

void

Исключения

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

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

array items()

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

Return Value

array

int firstItem()

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

Return Value

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)

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

Parameters

string	$pageName
int	$default

Return Value

int

static void currentPageResolver(Closure $resolver)

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

Parameters

Closure

$resolver

Return Value

void

static Factory viewFactory()

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

Return Value

Factory

static void viewFactoryResolver(Closure $resolver)

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

Parameters

Closure

$resolver

Return Value

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

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

Return Value

void

ArrayIterator getIterator()

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

Return Value

ArrayIterator

bool isEmpty()

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

Return Value

bool

bool isNotEmpty()

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

Return Value

bool

int count()

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

Return Value

int

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

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

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

Коллекция

$this setCollection(Коллекция $collection)

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

Параметры

Коллекция

$collection

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

$this

массив getOptions()

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

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

массив

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

строка toHtml()

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

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

строка

mixed __call(string $method, array $parameters)

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

Параметры

string	$method
массив	$parameters

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

mixed

строка __toString()

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

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

строка

void __construct(mixed $items, int $total, int $perPage, int|null $currentPage = null, array $options = [])

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

Параметры

mixed	$items
int	$total
int	$perPage
int\|null	$currentPage
массив	$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

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