Paginator

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

Свойства

ForwardsCalls

Свойства

protected Collection	$items	Все элементы, подлежащие постраничной навигации.	из AbstractPaginator
protected int	$perPage	Количество элементов на странице.	из AbstractPaginator
protected int	$currentPage	Текущая просматриваемая страница.	из AbstractPaginator
protected string	$path	Базовый путь, назначаемый всем URL-адресам.	из AbstractPaginator
protected array	$query	Параметры запроса, добавляемые ко всем URL-адресам.	из AbstractPaginator
protected string\|null	$fragment	Фрагмент URL-адреса, добавляемый ко всем URL-адресам.	из AbstractPaginator
protected string	$pageName	Переменная строки запроса, используемая для хранения номера страницы.	из AbstractPaginator
int	$onEachSide	Количество ссылок, отображаемых по обе стороны от ссылки текущей страницы.	из AbstractPaginator
protected array	$options	Параметры постраничной навигации.	из AbstractPaginator
static protected Closure	$currentPathResolver	Обратный вызов для определения текущего пути.	из AbstractPaginator
static protected Closure	$currentPageResolver	Обратный вызов для определения текущей страницы.	из AbstractPaginator
static protected Closure	$viewFactoryResolver	Обратный вызов для определения фабрики представления.	из AbstractPaginator
static string	$defaultView	Предпочтительное представление постраничной навигации.	из AbstractPaginator
static string	$defaultSimpleView	Предпочтительное "простое" представление постраничной навигации.	из AbstractPaginator
protected	$hasMore	Определяет, есть ли больше элементов в источнике данных.

Методы

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
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
string	toHtml() Отобразить содержимое пагинатора в HTML.	from AbstractPaginator
mixed	__call(string $method, array $parameters) Вызвать динамический метод в наборе данных.	from AbstractPaginator
string	__toString() Отобразить содержимое пагинатора при приведении к строке.	from AbstractPaginator
void	__construct(mixed $items, int $perPage, int\|null $currentPage = null, array $options = []) Создать новый экземпляр пагинатора.
int	setCurrentPage(int $currentPage) Получить текущую страницу для запроса.
void	setItems(mixed $items) Установить элементы для пагинатора.
string\|null	nextPageUrl() Получить URL для следующей страницы.
string	links(string\|null $view = null, array $data = []) Отобразить пагинатор с помощью заданного представления.
string	render(string\|null $view = null, array $data = []) Отобразить пагинатор с помощью заданного представления.
$this	hasMorePagesWhen(bool $hasMore = true) Вручную указать, что у пагинатора есть ещё страницы.
bool	hasMorePages() Определить, есть ли ещё элементы в источнике данных.
array	toArray() Получить экземпляр в виде массива.
array	jsonSerialize() Преобразовать объект в формат, пригодный для сериализации JSON.
string	toJson(int $options = 0) Преобразовать объект в его JSON-представление.

Подробности

protected mixed forwardCallTo(mixed $object, string $method, array $parameters)

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

Parameters

mixed	$object
string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

static protected void throwBadMethodCallException(string $method)

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

Parameters

string

$method

Return Value

void

Exceptions

BadMethodCallException

protected bool isValidPageNumber(int $page)

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

Parameters

int

$page

Return Value

bool

string|null previousPageUrl()

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

Return Value

string|null

массив getUrlRange(int $start, int $end)

Создать диапазон страниц для пагинации.

Параметры

int	$start
int	$end

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

массив

строка url(int $page)

Получить URL для заданного номера страницы.

Параметры

int

$page

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

строка

$this|строка|null fragment(string|null $fragment = null)

Получить/установить фрагмент URL, который будет добавлен к URL.

Параметры

строка|null

$fragment

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

$this|строка|null

$this appends(array|string|null $key, string|null $value = null)

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

Параметры

массив\|строка\|null	$key
строка\|null	$value

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

$this

protected $this appendArray(array $keys)

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

Параметры

массив

$keys

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

$this

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

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

Параметры

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

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

$this

protected строка buildFragment()

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

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

строка

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

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

Параметры

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

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

$this

массив items()

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

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

массив

целое число firstItem()

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

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

целое число

целое число lastItem()

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

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

целое число

целое число perPage()

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

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

целое число

булево hasPages()

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

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

булево

булево onFirstPage()

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

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

булево

целое число currentPage()

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

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

целое число

строка getPageName()

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

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

строка

$this setPageName(string $name)

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

Параметры

строка

$name

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

$this

$this withPath(string $path)

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

Параметры

строка

$path

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

$this

$this setPath(string $path)

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

Параметры

строка

$path

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

$this

$this onEachSide(int $count)

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

Параметры

целое число

$count

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

$this

static строка resolveCurrentPath(string $default = '/')

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

Параметры

строка

$default

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

строка

static пусто currentPathResolver(Closure $resolver)

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

Параметры

Closure

$resolver

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

пусто

static целое число resolveCurrentPage(string $pageName = 'page', int $default = 1)

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

Параметры

строка	$pageName
целое число	$default

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

целое число

static пусто currentPageResolver(Closure $resolver)

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

Параметры

Closure

$resolver

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

пусто

static Factory viewFactory()

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

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

Factory

static void viewFactoryResolver(Closure $resolver)

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

Параметры

Closure

$resolver

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

void

static void defaultView(string $view)

Установить представление по умолчанию для пагинации.

Параметры

string

$view

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

void

static void defaultSimpleView(string $view)

Установить представление по умолчанию для «простой» пагинации.

Параметры

string

$view

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

void

static void useBootstrapThree()

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

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

void

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, int|null $currentPage = null, array $options = [])

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

Параметры

mixed	$items
int	$perPage
int\|null	$currentPage
array	$options	(path, query, fragment, pageName)

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

void

protected int setCurrentPage(int $currentPage)

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

Параметры

int

$currentPage

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

int

protected void setItems(mixed $items)

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

Параметры

mixed

$items

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

void

string|null nextPageUrl()

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

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

string|null

string links(string|null $view = null, array $data = [])

Отобразить пагинатор с помощью заданного представления.

Параметры

string\|null	$view
array	$data

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

string

string render(string|null $view = null, array $data = [])

Отобразить разбиение на страницы с помощью заданного представления.

Параметры

string\|null	$view
array	$data

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

string

$this hasMorePagesWhen(bool $hasMore = true)

Вручную указать, что разбиение на страницы имеет дополнительные страницы.

Параметры

bool

$hasMore

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

$this

bool hasMorePages()

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

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

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/5.8/Illuminate/Pagination/Paginator.html