CursorPaginator

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

Трейты

ForwardsCalls

Tappable

Свойства

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

protected массив	$options	Параметры постраничной навигации.	из AbstractCursorPaginator
статический protected Closure	$currentCursorResolver	Обратный вызов текущего решателя курсора.	из AbstractCursorPaginator
protected	$hasMore	Указывает, есть ли больше элементов в источнике данных.

Методы

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
$this\|HigherOrderTapProxy	tap(callable\|null $callback = null) Вызвать переданный замыкание с этим экземпляром, а затем вернуть экземпляр.	из Tappable
string	url(Cursor\|null $cursor) Получить URL для заданного курсора.	из AbstractCursorPaginator
string\|null	previousPageUrl() Получить URL для предыдущей страницы.	из AbstractCursorPaginator

string\|null	nextPageUrl() URL следующей страницы, или null.	from AbstractCursorPaginator
Cursor\|null	previousCursor() Получить «маркер», указывающий на предыдущую группу элементов.	from AbstractCursorPaginator
Cursor\|null	nextCursor() Получить «маркер», указывающий на следующую группу элементов.	from AbstractCursorPaginator
Cursor	getCursorForItem(ArrayAccess\|stdClass $item, bool $isNext = true) Получить экземпляр маркера для данного элемента.	from AbstractCursorPaginator
array	getParametersForItem(ArrayAccess\|stdClass $item) Получить параметры маркера для данного объекта.	from AbstractCursorPaginator

string\|null	getPivotParameterForItem(ArrayAccess\|stdClass $item, string $parameterName) Получить значение параметра курсора из связанной модели, если применимо.	from AbstractCursorPaginator
mixed	ensureParameterIsPrimitive(mixed $parameter) Убедиться, что параметр является примитивным типом.	from AbstractCursorPaginator
$this\|string\|null	fragment(string\|null $fragment = null) Получить/установить фрагмент URL, который будет добавлен к URL.	from AbstractCursorPaginator
$this	appends(array\|string\|null $key, string\|null $value = null) Добавить набор значений строки запроса к пагинатору.	from AbstractCursorPaginator
$this	appendArray(array $keys) Добавить массив значений строки запроса.	from AbstractCursorPaginator
$this	withQueryString() Добавить все текущие значения строки запроса к пагинатору.	from AbstractCursorPaginator

$this	addQuery(string $key, string $value) Добавить значение параметра запроса к пагинатору.	from AbstractCursorPaginator
string	buildFragment() Сгенерировать полную часть фрагмента URL.	from AbstractCursorPaginator
$this	loadMorph(string $relation, array $relations) Загрузить набор отношений к смешанному набору отношений.	from AbstractCursorPaginator
$this	loadMorphCount(string $relation, array $relations) Загрузить набор подсчетов отношений к смешанному набору отношений.	from AbstractCursorPaginator
array	items() Получить срез элементов, подлежащих постраничной навигации.	from AbstractCursorPaginator
$this	through(callable $callback) Преобразовать каждый элемент в срезе элементов с помощью обратного вызова.	from AbstractCursorPaginator
int	perPage() Получить количество элементов на странице.	from AbstractCursorPaginator

Курсор\|null	cursor() Получить текущий курсор, по которому происходит постраничная навигация.	из AbstractCursorPaginator
строка	getCursorName() Получить имя переменной в строке запроса, используемой для хранения курсора.	из AbstractCursorPaginator
$this	setCursorName(строка $name) Установить имя переменной в строке запроса, используемой для хранения курсора.	из AbstractCursorPaginator
$this	withPath(строка $path) Установить базовый путь, который будет применён ко всем URL.	из AbstractCursorPaginator
$this	setPath(строка $path) Установить базовый путь, который будет применён ко всем URL.	из AbstractCursorPaginator
строка\|null	path() Получить базовый путь для сгенерированных URL-адресов постраничной навигации.	из AbstractCursorPaginator
статический Курсор\|null	resolveCurrentCursor(строка $cursorName = 'cursor', $default = null) Определить текущий курсор или вернуть значение по умолчанию.	из AbstractCursorPaginator

static void	currentCursorResolver(Closure $resolver) Установить текущий обработчик разрешения курсора.	from AbstractCursorPaginator
static Factory	viewFactory() Получить экземпляр фабрики представления из разрешителя.	from AbstractCursorPaginator
ArrayIterator	getIterator() Получить итератор для элементов.	from AbstractCursorPaginator
bool	isEmpty() Определить, пуст ли список элементов.	from AbstractCursorPaginator
bool	isNotEmpty() Определить, не пуст ли список элементов.	from AbstractCursorPaginator
int	count() Получить количество элементов для текущей страницы.	from AbstractCursorPaginator

Collection	getCollection() Получить базовую коллекцию пагинатора.	from AbstractCursorPaginator
$this	setCollection(Collection $collection) Установить базовую коллекцию пагинатора.	from AbstractCursorPaginator
array	getOptions() Получить опции пагинатора.	from AbstractCursorPaginator
bool	offsetExists(mixed $key) Определить, существует ли заданный элемент.	from AbstractCursorPaginator
mixed	offsetGet(mixed $key) Получить элемент по заданному смещению.	from AbstractCursorPaginator
void	offsetSet(mixed $key, mixed $value) Установить элемент по заданному смещению.	from AbstractCursorPaginator
void	offsetUnset(mixed $key) Удалить элемент по заданному ключу.	from AbstractCursorPaginator

string	toHtml() Отобразить содержимое пагинатора в HTML.	from AbstractCursorPaginator
mixed	__call(string $method, array $parameters) Вызвать динамические методы коллекции.	from AbstractCursorPaginator
string	__toString() Отобразить содержимое пагинатора при приведении к строке.	from AbstractCursorPaginator
void	__construct(mixed $items, int $perPage, Cursor\|null $cursor = null, array $options = []) Создать новый экземпляр пагинатора.
void	setItems(mixed $items) Установить элементы для пагинатора.
Htmlable	links(string\|null $view = null, array $data = []) Отобразить пагинатор с помощью заданного представления.
string	render(string\|null $view = null, array $data = []) Отобразить пагинатор с помощью заданного представления.
bool	hasMorePages() Определить, есть ли ещё элементы в источнике данных.
bool	hasPages() Определить, достаточно ли элементов для разделения на несколько страниц.

bool	onFirstPage() Определить, находится ли пагинатор на первой странице.
array	toArray() Получить экземпляр в виде массива.
array	jsonSerialize() Преобразовать объект в формат, сериализуемый в JSON.
string	toJson(int $options = 0) Преобразовать объект в его представление в формате JSON.

Подробности

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

Курсор|null previousCursor()

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

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

Курсор|null

Курсор|null nextCursor()

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

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

Курсор|null

Курсор getCursorForItem(ArrayAccess|stdClass $item, bool $isNext = true)

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

Параметры

ArrayAccess\|stdClass	$item
bool	$isNext

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

Курсор

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)

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

Параметры

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

Курсор|null 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

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 $perPage, Cursor|null $cursor = null, array $options = [])

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

Параметры

mixed	$items
int	$perPage
Cursor\|null	$cursor
array	$options	(путь, запрос, фрагмент, имя страницы)

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

void

protected void setItems(mixed $items)

Установить элементы для пагинатора.

Параметры

mixed

$items

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

void

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

bool hasMorePages()

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

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

bool

bool hasPages()

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

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

bool

bool onFirstPage()

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

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

bool

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/8.x/Illuminate/Pagination/CursorPaginator.html