AbstractCursorPaginator

абстрактный класс AbstractCursorPaginator реализует Htmlable, Stringable микcин 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) Передать вызов метода заданному объекту.	из ForwardsCalls
mixed	forwardDecoratedCallTo(mixed $object, string $method, array $parameters) Передать вызов метода заданному объекту, возвращая $this, если переданный вызов вернул себя.	из ForwardsCalls
static void	throwBadMethodCallException(string $method) Выбросить исключение некорректного вызова метода для данного метода.	из ForwardsCalls
tap($callback = null) Вызвать заданный замыкание с этим экземпляром, а затем вернуть экземпляр.	из 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() Получить экземпляр фабрики представлений из разрешителя.
Traversable	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)

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

Параметры

string

$method

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

void

Исключения

BadMethodCallException

tap($callback = null)

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

Параметры

$callback

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)

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

Параметры

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)

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

Параметры

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)

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

Параметры

string	$relation
array	$relations

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

$this

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

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

Параметры

string	$relation
array	$relations

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

$this

array items()

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

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

array

$this through(callable $callback)

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

Параметры

callable

$callback

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

$this

int perPage()

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

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

int

Cursor|null cursor()

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

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

Cursor|null

string getCursorName()

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

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

string

$this setCursorName(string $name)

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

Параметры

string

$name

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

$this

$this withPath(string $path)

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

Параметры

string

$path

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

$this

$this setPath(string $path)

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

Параметры

string

$path

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

$this

string|null path()

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

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

string|null

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

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

Параметры

string	$cursorName
	$default

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

Cursor|null

static void currentCursorResolver(Closure $resolver)

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

Параметры

Closure

$resolver

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

void

static Factory viewFactory()

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

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

Factory

Traversable getIterator()

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

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

Traversable

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

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