CursorPaginator

класс CursorPaginator расширяет AbstractCursorPaginator и реализует Arrayable, ArrayAccess, Countable, IteratorAggregate, Jsonable, JsonSerializable, CursorPaginator (View source)

Трейты

ForwardsCalls

Tappable

Свойства

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

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

Cursor\|null	previousCursor() Получить "маркер", указывающий на предыдущий набор элементов.	из AbstractCursorPaginator
Cursor\|null	nextCursor() Получить "маркер", указывающий на следующий набор элементов.	из AbstractCursorPaginator
Cursor	getCursorForItem(ArrayAccess\|stdClass $item, bool $isNext = true) Получить экземпляр маркера для данного элемента.	из AbstractCursorPaginator
array	getParametersForItem(ArrayAccess\|stdClass $item) Получить параметры маркера для данного объекта.	из AbstractCursorPaginator
string\|null	getPivotParameterForItem(ArrayAccess\|stdClass $item, string $parameterName) Получить значение параметра маркера из связанной модели (pivot), если применимо.	из 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
Cursor\|null	cursor() Получить текущий курсор, подвергаемый постраничной навигации.	from AbstractCursorPaginator
string	getCursorName() Получить имя переменной запроса, используемой для хранения курсора.	from AbstractCursorPaginator

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

static Factory	viewFactory() Получить экземпляр фабрики представлений из резолвера.	из AbstractCursorPaginator
Traversable	getIterator() Получить итератор для элементов.	из AbstractCursorPaginator
bool	isEmpty() Определить, пуст ли список элементов.	из AbstractCursorPaginator
bool	isNotEmpty() Определить, не пуст ли список элементов.	из AbstractCursorPaginator
int	count() Получить количество элементов для текущей страницы.	из AbstractCursorPaginator
Collection	getCollection() Получить базовый коллекцию пагинатора.	из AbstractCursorPaginator
$this	setCollection(Collection $collection) Установить базовую коллекцию пагинатора.	из 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() Отобразить содержимое разделителя страниц при приведении к строке.	из 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() Определить, находится ли разделитель страниц на первой странице.
bool	onLastPage() Определить, находится ли разделитель страниц на последней странице.
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

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

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

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

Параметры

ArrayAccess\|stdClass	$item
bool	$isNext

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

Курсор

array getParametersForItem(ArrayAccess|stdClass $item)

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

Параметры

ArrayAccess|stdClass

$item

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

array

Исключения

Исключение

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)

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

Параметры

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

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

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

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

Коллекция

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

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

Параметры

Коллекция

$collection

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

$this

массив getOptions()

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

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

массив

логическое значение offsetExists(смешанный тип $key)

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

Параметры

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

$key

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

логическое значение

смешанный тип offsetGet(смешанный тип $key)

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

Параметры

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

$key

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

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

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

bool onLastPage()

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

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

bool

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