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	$presenterResolver	Обратный вызов для определения презентера по умолчанию.

Методы

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

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

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 void

presenter(Closure $resolver)

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

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)

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

Параметры

int

$page

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

bool

string getUrlRange(int $start, int $end)

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

Параметры

int	$start
int	$end

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

string

END_OF_DOCUMENT_MARKER

string url(int $page)

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

Параметры

int

$page

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

string

string|null previousPageUrl()

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

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

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

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 void presenter(Closure $resolver)

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

Параметры

Closure

$resolver

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

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

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