Spec-Zone.ru › Laravel 5.1

AbstractPaginator

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

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

bool offsetExists(mixed $key)

Определить, существует ли данный элемент.

mixed offsetGet(mixed $key)

Получить элемент по заданному смещению.

void offsetSet(mixed $key, mixed $value)

Установить элемент по заданному смещению.

void offsetUnset(mixed $key)

Удалить элемент по заданному ключу.

mixed __call(string $method, array $parameters)

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

string __toString()

Отобразить содержимое постраничного навигатора при приведении к строке.

Details

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 предыдущей страницы.

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

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

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

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API