Пагинатор

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

Свойства

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) Определить, является ли данное значение допустимым номером страницы.	из AbstractPaginator
string	getUrlRange(int $start, int $end) Создать диапазон страниц для постраничной навигации.	из AbstractPaginator
string	url(int $page) Получить URL для указанного номера страницы.	из AbstractPaginator
string\|null	previousPageUrl() Получить URL для предыдущей страницы.	из AbstractPaginator
$this\|string\|null	fragment(string\|null $fragment = null) Получить/установить фрагмент URL, который нужно добавить к URL.	из AbstractPaginator
$this	appends(array\|string $key, string\|null $value = null) Добавить набор значений параметров запроса к постраничному навигатору.	из AbstractPaginator
$this	appendArray(array $keys) Добавить массив значений параметров запроса.	из AbstractPaginator
$this	addQuery(string $key, string $value) Добавить значение параметра запроса к постраничному навигатору.	из AbstractPaginator
string	buildFragment() Сформировать полную часть фрагмента URL.	из AbstractPaginator
array	items() Получить фрагмент элементов, которые отображаются на странице.	из AbstractPaginator
int	firstItem() Получить номер первого элемента в фрагменте.	из AbstractPaginator
int	lastItem() Получить номер последнего элемента в фрагменте.	из AbstractPaginator
int	perPage() Получить количество элементов на странице.	из AbstractPaginator
bool	onFirstPage() Определить, находится ли постраничный навигатор на первой странице.	из AbstractPaginator
int	currentPage() Получить текущую страницу.	из AbstractPaginator
bool	hasPages() Определить, достаточно ли элементов для разделения на несколько страниц.	из AbstractPaginator
static string	resolveCurrentPath(string $default = '/') Определить текущий путь запроса или вернуть значение по умолчанию.	из AbstractPaginator
static void	currentPathResolver(Closure $resolver) Установить обратный вызов для определения текущего пути запроса.	из AbstractPaginator
static int	resolveCurrentPage(string $pageName = 'page', int $default = 1) Определить текущую страницу или вернуть значение по умолчанию.	из AbstractPaginator
static void	currentPageResolver(Closure $resolver) Установить обратный вызов для определения текущей страницы.	из AbstractPaginator
static Factory	viewFactory() Получить экземпляр фабрики представления из разрешающего элемента.	из AbstractPaginator
static void	viewFactoryResolver(Closure $resolver) Установить обратный вызов для разрешения фабрики представлений.	из AbstractPaginator
static void	defaultView(string $view) Установить представление по умолчанию для постраничной навигации.	из AbstractPaginator
static void	defaultSimpleView(string $view) Установить представление по умолчанию для "простой" постраничной навигации.	из AbstractPaginator
string	getPageName() Получить имя параметра в строке запроса, используемого для хранения номера страницы.	из AbstractPaginator
$this	setPageName(string $name) Установить имя параметра в строке запроса, используемого для хранения номера страницы.	из AbstractPaginator
$this	setPath(string $path) Установить базовый путь для всех URL.	из AbstractPaginator
ArrayIterator	getIterator() Получить итератор для элементов.	из AbstractPaginator
bool	isEmpty() Определить, пустой ли список элементов.	из AbstractPaginator
int	count() Получить количество элементов на текущей странице.	из AbstractPaginator
Collection	getCollection() Получить основную коллекцию постраничного навигатора.	из AbstractPaginator

$this	setCollection(Collection $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	checkForMorePages() Проверить наличие дополнительных страниц. Последний элемент будет удален.
string\|null	nextPageUrl() Получить URL следующей страницы.
$this	hasMorePagesWhen(bool $value = true) Вручную указать, что у пагинатора есть дополнительные страницы.
bool	hasMorePages() Определить, есть ли дополнительные элементы в источнике данных.
string	links(string\|null $view = null) Отобразить пагинатор с помощью заданного представления.
string	render(string\|null $view = null) Отобразить пагинатор с помощью заданного представления.
array	toArray() Получить экземпляр в виде массива.
array	jsonSerialize() Преобразовать объект в сериализуемый в JSON формат.
string	toJson(int $options) Преобразовать объект в его представление JSON.

Подробности

protected bool isValidPageNumber(int $page)

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

Parameters

int

$page

Return Value

bool

string getUrlRange(int $start, int $end)

Создать диапазон URL-адресов пагинации.

Parameters

int	$start
int	$end

Return Value

string

string url(int $page)

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

Parameters

int

$page

Return Value

string

string|null previousPageUrl()

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

Return Value

string|null

$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

$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

int perPage()

Получить количество элементов на странице.

Return Value

int

bool onFirstPage()

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

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

bool

int currentPage()

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

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

int

bool hasPages()

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

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

bool

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

string getPageName()

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

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

string

$this setPageName(string $name)

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

Параметры

string

$name

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

$this

$this setPath(string $path)

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

Параметры

string

$path

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

$this

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 checkForMorePages()

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

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

void

string|null nextPageUrl()

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

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

string|null

$this hasMorePagesWhen(bool $value = true)

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

Параметры

bool

$value

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

$this

bool hasMorePages()

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

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

bool

string links(string|null $view = null)

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

Параметры

string|null

$view

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

string

string render(string|null $view = null)

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

Параметры

string|null

$view

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

string

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