Страничный навигатор

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

Свойства

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
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	Определяет, есть ли ещё элементы в источнике данных.

Методы

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 $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
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
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
ArrayIterator	getIterator() Получить итератор для элементов.	from AbstractPaginator
bool	isEmpty() Определить, пуст ли список элементов.	from AbstractPaginator
int	count() Получить количество элементов на текущей странице.	from AbstractPaginator

Коллекция	getCollection() Получить коллекцию, лежащую в основе разбиения.	из AbstractPaginator
$this	setCollection(Коллекция $collection) Установить коллекцию, лежащую в основе разбиения.	из AbstractPaginator
bool	offsetExists(mixed $key) Определить, существует ли заданный элемент.	из AbstractPaginator
mixed	offsetGet(mixed $key) Получить элемент по заданному смещению.	из AbstractPaginator
void	offsetSet(mixed $key, mixed $value) Установить элемент по заданному смещению.	из AbstractPaginator
void	offsetUnset(mixed $key) Удалить элемент по заданному ключу.	из AbstractPaginator
string	toHtml() Вывести содержимое разбиения в HTML.	из AbstractPaginator
mixed	__call(string $method, array $parameters) Вызвать динамические методы для коллекции.	из AbstractPaginator
string	__toString() Вывести содержимое разбиения при приведении к строке.	из 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 $value = true) Вручную указать, что разбиение имеет дополнительные страницы.
bool	hasMorePages() Определить, есть ли дополнительные элементы в источнике данных.
array	toArray() Получить экземпляр в виде массива.
array	jsonSerialize() Преобразовать объект в сериализуемый в JSON.
string	toJson(int $options) Преобразовать объект в его представление JSON.

Подробности

protected bool isValidPageNumber(int $page)

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

Parameters

int

$page

Return Value

bool

string|null previousPageUrl()

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

Return Value

string|null

array getUrlRange(int $start, int $end)

Создать диапазон URL страниц разбиения.

Parameters

int	$start
int	$end

Return Value

array

string url(int $page)

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

Parameters

int

$page

Return Value

string

$this|string|null fragment(string|null $fragment = null)

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

Parameters

string|null

$fragment

Return Value

$this|string|null

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

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

Parameters

array\|string	$key
string\|null	$value

Return Value

$this

protected $this appendArray(array $keys)

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

Parameters

array

$keys

Return Value

$this

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

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

Parameters

string	$key
string	$value

Return Value

$this

protected string buildFragment()

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

Return Value

string

array items()

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

Return Value

array

int firstItem()

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

Return Value

int

int lastItem()

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

Return Value

int

END_OF_DOCUMENT_MARKER

int perPage()

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

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

int

bool hasPages()

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

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

bool

bool onFirstPage()

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

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

bool

int currentPage()

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

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

int

string getPageName()

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

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

string

$this setPageName(string $name)

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

Параметры

string

$name

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

$this

$this withPath(string $path)

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

Параметры

string

$path

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

$this

$this setPath(string $path)

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

Параметры

string

$path

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

$this

static string resolveCurrentPath(string $default = '/')

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

Параметры

string

$default

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

string

static void currentPathResolver(Closure $resolver)

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

Параметры

Closure

$resolver

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

void

static int resolveCurrentPage(string $pageName = 'page', int $default = 1)

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

Параметры

string	$pageName
int	$default

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

int

static void currentPageResolver(Closure $resolver)

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

Параметры

Closure

$resolver

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

void

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

ArrayIterator getIterator()

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

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

ArrayIterator

bool isEmpty()

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

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

bool

int count()

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

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

int

Collection getCollection()

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

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

Collection

$this setCollection(Collection $collection)

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

Параметры

Collection

$collection

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

$this

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 $value = true)

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

Параметры

bool

$value

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

$this

bool hasMorePages()

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

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

bool

array toArray()

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

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

array

array jsonSerialize()

Преобразовать объект в формат, сериализуемый в JSON.

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

array

string toJson(int $options)

Преобразовать объект в его представление в формате JSON.

Параметры

int

$options

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

string

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