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

getUrlRange(int $start, int $end)

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

string

url(int $page)

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

string|null

previousPageUrl()

Получить 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-адреса.

array

items()

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

int

firstItem()

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

int

lastItem()

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

int

perPage()

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

bool

onFirstPage()

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

int

currentPage()

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

bool

hasPages()

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

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)

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

string

getPageName()

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

$this

setPageName(string $name)

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

$this

setPath(string $path)

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

ArrayIterator

getIterator()

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

bool

isEmpty()

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

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)

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

Parameters

int

$page

Return Value

bool

string getUrlRange(int $start, int $end)

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

Parameters

int	$start
int	$end

Return Value

string

string url(int $page)

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

Parameters

int

$page

Return Value

string

string|null previousPageUrl()

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

Return Value

string|null

$this|string|null fragment(string|null $fragment = null)

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

Параметры

string|null

$fragment

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

$this|string|null

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

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

Параметры

array\|string	$key
string\|null	$value

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

$this

protected $this appendArray(array $keys)

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

Параметры

array

$keys

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

$this

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

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

Параметры

string	$key
string	$value

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

$this

protected string buildFragment()

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

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

string

array items()

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

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

array

int firstItem()

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

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

int

int lastItem()

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

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

int

int perPage()

Получить количество элементов на странице.

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

int

bool onFirstPage()

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

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

bool

int currentPage()

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

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

int

bool hasPages()

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

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

bool

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

string getPageName()

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

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

string

$this setPageName(string $name)

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

Параметры

string

$name

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

$this

$this setPath(string $path)

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

Параметры

string

$path

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

$this

ArrayIterator getIterator()

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

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

ArrayIterator

bool isEmpty()

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

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

bool

int count()

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

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

int

Коллекция getCollection()

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

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

Коллекция

$this setCollection(Коллекция $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.3/Illuminate/Pagination/AbstractPaginator.html