AbstractCursorPaginator

абстрактный класс AbstractCursorPaginator реализует Htmlable mixin Collection (View source)

Особенности

Свойства

protected Collection	$items	Все элементы, которые постраничиваются.
protected int	$perPage	Количество элементов на странице.
protected string	$path	Базовый путь для всех URL.
protected array	$query	Параметры запроса для добавления ко всем URL.
protected string\|null	$fragment	Фрагмент URL для добавления ко всем URL.
protected string	$cursorName	Переменная строки курсора, используемая для хранения страницы.
protected Cursor\|null	$cursor	Текущий курсор.
protected array	$parameters	Параметры постраничника для курсора.
protected array	$options	Параметры постраничника.
static protected Closure	$currentCursorResolver	Обратный вызов для определения текущего курсора.

Методы

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
string	url(Cursor\|null $cursor) Получить URL для заданного курсора.
string\|null	previousPageUrl() Получить URL для предыдущей страницы.
string\|null	nextPageUrl() URL для следующей страницы или null.
Cursor\|null	previousCursor() Получить "курсор", указывающий на предыдущий набор элементов.
Cursor\|null	nextCursor() Получить "курсор", указывающий на следующий набор элементов.
Cursor	getCursorForItem(ArrayAccess\|stdClass $item, bool $isNext = true) Получить экземпляр курсора для заданного элемента.
array	getParametersForItem(ArrayAccess\|stdClass $item) Получить параметры курсора для заданного объекта.
string\|null	getPivotParameterForItem(ArrayAccess\|stdClass $item, string $parameterName) Получить значение параметра курсора из модели pivot, если применимо.
mixed	ensureParameterIsPrimitive(mixed $parameter) Убедиться, что параметр является примитивным типом.
$this\|string\|null	fragment(string\|null $fragment = null) Получить / установить фрагмент URL, который будет добавлен к URL-адресам.
$this	appends(array\|string\|null $key, string\|null $value = null) Добавить набор значений строки запроса к пагинатору.
$this	appendArray(array $keys) Добавить массив значений строки запроса.
$this	withQueryString() Добавить все текущие значения строки запроса к пагинатору.
$this	addQuery(string $key, string $value) Добавить значение строки запроса к пагинатору.
string	buildFragment() Построить полную часть фрагмента URL.
$this	loadMorph(string $relation, array $relations) Загрузить набор отношений в смешанную коллекцию отношений.
$this	loadMorphCount(string $relation, array $relations) Загрузить набор подсчетов отношений в смешанную коллекцию отношений.
array	items() Получить фрагмент элементов, которые подвергаются постраничной разбивке.
$this	through(callable $callback) Преобразовать каждый элемент во фрагменте элементов с помощью обратного вызова.
int	perPage() Получить количество элементов, отображаемых на странице.
Cursor\|null	cursor() Получить текущий курсор, который подвергается постраничной разбивке.
string	getCursorName() Получить переменную строки запроса, используемую для хранения курсора.
$this	setCursorName(string $name) Установить переменную строки запроса, используемую для хранения курсора.
$this	withPath(string $path) Установить базовый путь для присваивания всем URL-адресам.
$this	setPath(string $path) Установить базовый путь для присваивания всем URL-адресам.
string\|null	path() Получить базовый путь для URL-адресов, созданных пагинатором.
static Cursor\|null	resolveCurrentCursor(string $cursorName = 'cursor', $default = null) Определить текущий курсор или вернуть значение по умолчанию.
static void	currentCursorResolver(Closure $resolver) Установить текущий обратный вызов обработчика курсора.
static Factory	viewFactory() Получить экземпляр фабрики представлений от обработчика.
ArrayIterator	getIterator() Получить итератор для элементов.
bool	isEmpty() Определить, пуст ли список элементов.
bool	isNotEmpty() Определить, не пуст ли список элементов.
int	count() Получить количество элементов для текущей страницы.
Collection	getCollection() Получить базовую коллекцию пагинатора.
$this	setCollection(Collection $collection) Установить базовую коллекцию пагинатора.
array	getOptions() Получить параметры пагинатора.
bool	offsetExists(mixed $key) Определить, существует ли заданный элемент.

mixed	offsetGet(mixed $key) Получить элемент по заданному смещению.
void	offsetSet(mixed $key, mixed $value) Установить элемент по заданному смещению.
void	offsetUnset(mixed $key) Удалить элемент по заданному ключу.
string	toHtml() Отобразить содержимое разделителя страниц в HTML.
mixed	__call(string $method, array $parameters) Вызвать динамический метод коллекции.
string	__toString() Отобразить содержимое разделителя страниц при приведении к строке.

Подробности

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

string url(Cursor|null $cursor)

Получить URL для заданного курсора.

Параметры

Cursor|null

$cursor

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

string

string|null previousPageUrl()

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

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

string|null

string|null nextPageUrl()

URL для следующей страницы, или null.

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

string|null

Cursor|null previousCursor()

Получить «курсор», указывающий на предыдущий набор элементов.

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

Cursor|null

Cursor|null nextCursor()

Получить «курсор», указывающий на следующий набор элементов.

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

Cursor|null

Cursor getCursorForItem(ArrayAccess|stdClass $item, bool $isNext = true)

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

Параметры

ArrayAccess\|stdClass	$item
bool	$isNext

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

Cursor

array getParametersForItem(ArrayAccess|stdClass $item)

Получить параметры курсора для данного объекта.

Параметры

ArrayAccess|stdClass

$item

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

array

Исключения

Exception

protected string|null getPivotParameterForItem(ArrayAccess|stdClass $item, string $parameterName)

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

Параметры

ArrayAccess\|stdClass	$item
string	$parameterName

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

string|null

protected mixed ensureParameterIsPrimitive(mixed $parameter)

Убедиться, что параметр является примитивным типом.

Это может устранить проблемы, возникающие, когда разработчик использует объект значения для атрибута.

Параметры

mixed

$parameter

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

mixed

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

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

Параметры

массив

$keys

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

$this

$this withQueryString()

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

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

$this

protected $this addQuery(string $key, string $value)

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

Параметры

строка	$key
строка	$value

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

$this

protected string buildFragment()

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

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

строка

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

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

Параметры

строка	$relation
массив	$relations

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

$this

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

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

Параметры

строка	$relation
массив	$relations

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

$this

array items()

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

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

массив

$this through(callable $callback)

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

Параметры

обратный вызов

$callback

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

$this

int perPage()

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

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

целое число

Cursor|null cursor()

Получить текущий курсор, подлежащий пагинации.

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

Cursor|null

string getCursorName()

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

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

строка

$this setCursorName(string $name)

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

Параметры

строка

$name

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

$this

$this withPath(string $path)

Установить базовый путь, который нужно назначить всем URL.

Параметры

строка

$path

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

$this

$this setPath(string $path)

Установить базовый путь, который нужно назначить всем URL.

Параметры

строка

$path

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

$this

string|null path()

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

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

строка|null

static Cursor|null resolveCurrentCursor(string $cursorName = 'cursor', $default = null)

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

Параметры

строка	$cursorName
	$default

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

Cursor|null

static void currentCursorResolver(Closure $resolver)

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

Параметры

Closure

$resolver

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

void

static Factory viewFactory()

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

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

Factory

ArrayIterator getIterator()

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

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

ArrayIterator

bool isEmpty()

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

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

bool

bool isNotEmpty()

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

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

bool

int count()

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

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

целое число

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

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