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.

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)

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

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)

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

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.

Параметры

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

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

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

END_OF_DOCUMENT_MARKER

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