Страничник

класс Страничник расширяет 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) Определить, является ли данное значение корректным номером страницы.	из AbstractPaginator
string\|null	previousPageUrl() Получить URL предыдущей страницы.	из AbstractPaginator
array	getUrlRange(int $start, int $end) Создать диапазон URL страниц пагинации.	из AbstractPaginator
string	url(int $page) Получить 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	hasPages() Определить, достаточно ли элементов для разделения на несколько страниц.	из AbstractPaginator
bool	onFirstPage() Определить, находится ли пагинатор на первой странице.	из AbstractPaginator
int	currentPage() Получить текущую страницу.	из AbstractPaginator
string	getPageName() Получить имя переменной строки запроса, используемой для хранения номера страницы.	из AbstractPaginator
$this	setPageName(string $name) Установить имя переменной строки запроса, используемой для хранения номера страницы.	из AbstractPaginator
$this	withPath(string $path) Установить базовый путь, который следует назначить всем URL-адресам.	из AbstractPaginator
$this	setPath(string $path) Установить базовый путь, который следует назначить всем URL-адресам.	из 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
ArrayIterator	getIterator() Получить итератор для элементов.	из AbstractPaginator
bool	isEmpty() Определить, пуст ли список элементов.	из AbstractPaginator
bool	isNotEmpty() Определить, не пуст ли список элементов.	из 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	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()

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

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

int

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

bool isNotEmpty()

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

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

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