Абстрактный разбиение на страницы

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

Свойствa

Свойства

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)

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

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)

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

Parameters

mixed	$object
string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

static protected void throwBadMethodCallException(string $method)

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

Parameters

string

$method

Return Value

void

Exceptions

BadMethodCallException

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|null $key, string|null $value = null)

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

Parameters

array\|string\|null	$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

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

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

Parameters

string	$relation
array	$relations

Return Value

$this

array items()

Получить срез элементов, подлежащих пагинации.

Return Value

array

int firstItem()

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

Return Value

int

int lastItem()

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

Return Value

int

int perPage()

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

Return Value

int

bool hasPages()

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

Return Value

bool

bool onFirstPage()

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

Return Value

bool

int currentPage()

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

Return Value

int

string getPageName()

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

Return Value

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

END_OF_DOCUMENT_MARKER

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

static void useBootstrapThree()

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

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

void

ArrayIterator getIterator()

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

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

ArrayIterator

bool isEmpty()

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

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

bool

bool isNotEmpty()

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

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

bool

int count()

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

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

int

Collection getCollection()

Получить базовый набор элементов пагинатора.

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

Collection

$this setCollection(Collection $collection)

Установить базовый набор элементов пагинатора.

Параметры

Collection

$collection

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

$this

array getOptions()

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

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

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/5.8/Illuminate/Pagination/AbstractPaginator.html