AbstractPaginator

абстрактный класс AbstractPaginator реализует Htmlable mixin 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	$queryStringResolver	Обратный вызов для определения строки запроса.
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) Создать диапазон страниц для постраничной навигации.
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	withQueryString() Добавить все текущие значения параметров запроса к постраничнику.
$this	addQuery(string $key, string $value) Добавить значение параметра запроса к постраничнику.
string	buildFragment() Сформировать полную часть фрагмента URL.
$this	loadMorph(string $relation, array $relations) Загрузить набор отношений на смешанную коллекцию отношений.
$this	loadMorphCount(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 void	queryStringResolver(Closure $resolver) Установить обратный вызов для определения строки запроса.
static Factory	viewFactory() Получить экземпляр фабрики представления из резолвера.
static void	viewFactoryResolver(Closure $resolver) Установить обратный вызов для резолвера фабрики представления.
static void	defaultView(string $view) Установить представление по умолчанию для постраничной навигации.
static void	defaultSimpleView(string $view) Установить представление по умолчанию для "простой" постраничной навигации.
static void	useTailwind() Указать, что для сгенерированных ссылок следует использовать стили Tailwind.
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

$this withQueryString()

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

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

$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

$this loadMorphCount(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)

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

Parameters

string

$name

Return Value

$this

$this withPath(string $path)

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

Parameters

string

$path

Return Value

$this

$this setPath(string $path)

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

Parameters

string

$path

Return Value

$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 void queryStringResolver(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 useTailwind()

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

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

Получить базовый набор paginator.

Return Value

Collection

$this setCollection(Collection $collection)

Установить базовый набор paginator.

Parameters

Collection

$collection

Return Value

$this

array getOptions()

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

Return Value

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

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