AbstractPaginator

class AbstractPaginator implements Htmlable (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	Переменная строки запроса, используемая для хранения номера страницы.
static protected Closure	$currentPathResolver	Обратный вызов для определения текущего пути.
static protected Closure	$currentPageResolver	Обратный вызов для определения текущей страницы.
static protected Closure	$viewFactoryResolver	Обратный вызов для определения фабрики представления.
static string	$defaultView	Представление по умолчанию для постраничной навигации.
static string	$defaultSimpleView	Представление по умолчанию для "простого" отображения постраничной навигации.

Методы

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 $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-адресам.

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)

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

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 bool isValidPageNumber(int $page)

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

Параметры

int

$page

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

bool

string|null previousPageUrl()

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

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

string|null

массив getUrlRange(int $start, int $end)

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

Параметры

int	$start
int	$end

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

массив

строка url(int $page)

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

Параметры

int

$page

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

строка

$this|строка|null fragment(string|null $fragment = null)

Получить/установить фрагмент URL, который будет добавлен к URL-адресам.

Параметры

строка|null

$fragment

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

$this|строка|null

$this appends(array|string $key, string|null $value = null)

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

Параметры

массив\|строка	$key
строка\|null	$value

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

$this

protected $this appendArray(array $keys)

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

Параметры

массив

$keys

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

$this

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

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

Параметры

строка	$key
строка	$value

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

$this

protected строка buildFragment()

Сгенерировать полную часть фрагмента URL.

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

строка

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

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

Параметры

строка	$relation
массив	$relations

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

$this

массив items()

Получить срез элементов, которые постраничиваются.

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

массив

целое firstItem()

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

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

целое

целое lastItem()

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

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

целое

целое perPage()

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

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

целое

булево hasPages()

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

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

булево

булево onFirstPage()

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

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

булево

целое currentPage()

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

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

целое

строка getPageName()

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

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

строка

$this setPageName(string $name)

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

Параметры

строка

$name

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

$this

$this withPath(string $path)

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

Параметры

строка

$path

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

$this

$this setPath(string $path)

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

Параметры

строка

$path

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

$this

статический строка resolveCurrentPath(string $default = '/')

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

Параметры

строка

$default

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

строка

статический пустое currentPathResolver(Closure $resolver)

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

Параметры

Closure

$resolver

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

пустое

статический целое resolveCurrentPage(string $pageName = 'page', int $default = 1)

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

Параметры

строка	$pageName
целое	$default

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

целое

статический пустое currentPageResolver(Closure $resolver)

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

Параметры

Closure

$resolver

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

пустое

статический 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

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