AbstractPaginator

абстрактный класс AbstractPaginator реализует Htmlable микшин Collection (View source)

Свойства

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

Методы

mixed	forwardCallTo(mixed $object, string $method, array $parameters) Передать вызов метода данному объекту.	from ForwardsCalls
static void	throwBadMethodCallException(string $method) Выбросить исключение о плохом вызове метода для данного метода.	from ForwardsCalls
bool	isValidPageNumber(int $page) Определить, является ли данное значение допустимым номером страницы.
string\|null	previousPageUrl() Получить URL предыдущей страницы.
array	getUrlRange(int $start, int $end) Создать диапазон URL-адресов для пагинации.
string	url(int $page) Получить URL для заданного номера страницы.
$this\|string\|null	fragment(string\|null $fragment = null) Получить/установить фрагмент URL для добавления к URL-адресам.
$this	appends(array\|string\|null $key, string\|null $value = null) Добавить набор значений параметров запроса к пагинатору.
$this	appendArray(array $keys) Добавить массив значений параметров запроса.
$this	addQuery(string $key, string $value) Добавить значение параметра запроса к пагинатору.
string	buildFragment() Сформировать полную часть фрагмента URL.
$this	loadMorph(string $relation, array $relations) Загрузить набор отношений на смешанную коллекцию отношений.
array	items() Получить срез элементов, которые отображаются с помощью пагинации.
int	firstItem() Получить номер первого элемента в срезе.
int	lastItem() Получить номер последнего элемента в срезе.
int	perPage() Получить количество элементов, отображаемых на одной странице.
bool	hasPages() Определить, достаточно ли элементов для разделения на несколько страниц.
bool	onFirstPage() Определить, находится ли пагинатор на первой странице.
int	currentPage() Получить текущую страницу.
string	getPageName() Получить имя переменной строки запроса, используемой для хранения страницы.
$this	setPageName(string $name) Установить имя переменной строки запроса, используемой для хранения страницы.
$this	withPath(string $path) Установить базовый путь для назначения всем URL-адресам.
$this	setPath(string $path) Установить базовый путь для назначения всем URL-адресам.
$this	onEachSide(int $count) Установить количество ссылок, отображаемых по обе стороны от ссылки текущей страницы.
string\|null	path() Получить базовый путь для сгенерированных URL-адресов пагинатора.
static string	resolveCurrentPath(string $default = '/') Определить текущий путь запроса или вернуть значение по умолчанию.
static void	currentPathResolver(Closure $resolver) Установить обратный вызов для определения текущего пути запроса.
static int	resolveCurrentPage(string $pageName = 'page', int $default = 1) Определить текущую страницу или вернуть значение по умолчанию.
static void	currentPageResolver(Closure $resolver) Установить обратный вызов для определения текущей страницы.
static Factory	viewFactory() Получить экземпляр фабрики представлений из резолвера.
static void	viewFactoryResolver(Closure $resolver) Установить обратный вызов для получения резолвера фабрики представлений.
static void	defaultView(string $view) Установить представление по умолчанию для пагинации.
static void	defaultSimpleView(string $view) Установить представление по умолчанию "простое" для пагинации.
static void	useBootstrapThree() Указать, что для сгенерированных ссылок должна использоваться стилистика Bootstrap 3.
ArrayIterator	getIterator() Получить итератор для элементов.
bool	isEmpty() Определить, пуст ли список элементов.
bool	isNotEmpty() Определить, не пуст ли список элементов.
int	count() Получить количество элементов для текущей страницы.
Collection	getCollection() Получить базовый массив пагинатора.
$this	setCollection(Collection $collection) Установить базовый массив пагинатора.
array	getOptions() Получить параметры пагинатора.
bool	offsetExists(mixed $key) Определить, существует ли данный элемент.
mixed	offsetGet(mixed $key) Получить элемент по заданному смещению.
void	offsetSet(mixed $key, mixed $value) Установить элемент по заданному смещению.
void	offsetUnset(mixed $key) Удалить элемент по заданному ключу.
string	toHtml() Отобразить содержимое пагинатора в HTML.
mixed	__call(string $method, array $parameters) Выполнить динамические вызовы в коллекцию.

string

__toString()

Отобразить содержимое пагинатора при приведении к строке.

Подробности

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

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

Параметры

mixed	$object
string	$method
array	$parameters

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

mixed

Исключения

BadMethodCallException

static protected void throwBadMethodCallException(string $method)

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

Параметры

string

$method

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

void

Исключения

BadMethodCallException

protected bool isValidPageNumber(int $page)

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

Параметры

int

$page

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

bool

string|null previousPageUrl()

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

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

string|null

array getUrlRange(int $start, int $end)

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

Параметры

int	$start
int	$end

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

array

string url(int $page)

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

Параметры

int

$page

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

string

$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)

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

Параметры

array

$keys

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

$this

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

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

Параметры

string	$key
string	$value

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

$this

protected string buildFragment()

Создать полную фрагментарную часть URL-адреса.

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

string

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

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

Параметры

string	$relation
array	$relations

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

$this

array items()

Получить фрагмент элементов, которые будут отображены.

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

array

int firstItem()

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

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

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

$this onEachSide(int $count)

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

Parameters

int

$count

Return Value

$this

string|null path()

Получить базовый путь для сгенерированных URL-адресов пагинатора.

Return Value

string|null

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

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

Parameters

string

$default

Return Value

string

static void currentPathResolver(Closure $resolver)

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

Parameters

Closure

$resolver

Return Value

void

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

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

Parameters

string	$pageName
int	$default

Return Value

int

static void currentPageResolver(Closure $resolver)

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

Parameters

Closure

$resolver

Return Value

void

static Factory viewFactory()

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

Return Value

Factory

static void viewFactoryResolver(Closure $resolver)

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

Parameters

Closure

$resolver

Return Value

void

static void defaultView(string $view)

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

Parameters

string

$view

Return Value

void

static void defaultSimpleView(string $view)

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

Parameters

string

$view

Return Value

void

static void useBootstrapThree()

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

Return Value

void

ArrayIterator getIterator()

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

Return Value

ArrayIterator

bool isEmpty()

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

Return Value

bool

bool isNotEmpty()

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

Return Value

bool

int count()

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

Return Value

int

Collection getCollection()

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

Return Value

Collection

$this setCollection(Collection $collection)

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

Parameters

Collection

$collection

Return Value

$this

array getOptions()

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

Return Value

array

bool offsetExists(mixed $key)

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

Parameters

mixed

$key

Return Value

bool

mixed offsetGet(mixed $key)

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

Parameters

mixed

$key

Return Value

mixed

void offsetSet(mixed $key, mixed $value)

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

Parameters

mixed	$key
mixed	$value

Return Value

void

void offsetUnset(mixed $key)

Удалить элемент по заданному ключу.

Parameters

mixed

$key

Return Value

void

string toHtml()

Вывести содержимое пагинатора в HTML.

Return Value

string

END_OF_DOCUMENT_MARKER

смешанный тип __call(строка $method, массив $parameters)

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

Параметры

строка	$method
массив	$parameters

Значение результата

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

строка __toString()

Отобразить содержимое пагинатора при приведении к строке.

Значение результата

строка

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