Spec-Zone.ru › Laravel 5.6

LengthAwarePaginator

class LengthAwarePaginator extends AbstractPaginator implements Arrayable, ArrayAccess, Countable, IteratorAggregate, JsonSerializable, Jsonable, LengthAwarePaginator (View source)

Свойства

protected Collection $items Все элементы, подлежащие постраничной навигации. из AbstractPaginator
protected int $perPage Количество элементов на странице. из AbstractPaginator
protected int $currentPage Текущая просматриваемая страница. из AbstractPaginator
protected string $path Базовый путь, присваиваемый всем URL-адресам. из AbstractPaginator
protected array $query Параметры запроса, добавляемые ко всем URL-адресам. из AbstractPaginator
protected string|null $fragment Фрагмент URL-адреса, добавляемый ко всем URL-адресам. из AbstractPaginator
protected string $pageName Переменная в строке запроса, используемая для хранения номера страницы. из AbstractPaginator
static protected Closure $currentPathResolver Обратный вызов для получения текущего пути. из AbstractPaginator
static protected Closure $currentPageResolver Обратный вызов для получения текущей страницы. из AbstractPaginator
static protected Closure $viewFactoryResolver Обратный вызов для получения фабрики представления. из AbstractPaginator
static string $defaultView Предпочтительное представление для пагинации. из AbstractPaginator
static string $defaultSimpleView Предпочтительное "простое" представление для пагинации. из AbstractPaginator
protected int $total Общее количество элементов до усечения.
protected int $lastPage Последняя доступная страница.

Методы

bool isValidPageNumber(int $page)

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

 из AbstractPaginator
string|null previousPageUrl()

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

 из AbstractPaginator
array getUrlRange(int $start, int $end)

Создать диапазон URL страниц пагинации.

 из AbstractPaginator
string url(int $page)

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

 из AbstractPaginator
$this|string|null fragment(string|null $fragment = null)

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

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

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

 из AbstractPaginator
$this appendArray(array $keys)

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

 из AbstractPaginator
$this addQuery(string $key, string $value)

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

 из AbstractPaginator
string buildFragment()

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

 из AbstractPaginator
array items()

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

 из AbstractPaginator
int firstItem()

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

 из AbstractPaginator
int lastItem()

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

 из AbstractPaginator
int perPage()

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

 из AbstractPaginator
bool hasPages()

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

 из AbstractPaginator
bool onFirstPage()

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

 из AbstractPaginator
int currentPage()

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

 из AbstractPaginator
string getPageName()

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

 из AbstractPaginator
$this setPageName(string $name)

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

 из AbstractPaginator
$this withPath(string $path)

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

 из AbstractPaginator
$this setPath(string $path)

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

 из AbstractPaginator
static string resolveCurrentPath(string $default = '/')

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

 из AbstractPaginator
static void currentPathResolver(Closure $resolver)

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

 из AbstractPaginator
static int resolveCurrentPage(string $pageName = 'page', int $default = 1)

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

 из AbstractPaginator
static void currentPageResolver(Closure $resolver)

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

 из AbstractPaginator
static Factory viewFactory()

Получить экземпляр фабрики представления из разрешителя.

 из AbstractPaginator
static void viewFactoryResolver(Closure $resolver)

Установить обратный вызов для разрешения фабрики представления.

 из AbstractPaginator
static void defaultView(string $view)

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

 из AbstractPaginator
static void defaultSimpleView(string $view)

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

 из AbstractPaginator
ArrayIterator getIterator()

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

 из AbstractPaginator
bool isEmpty()

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

 из AbstractPaginator
bool isNotEmpty()

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

 из AbstractPaginator
int count()

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

 из AbstractPaginator
Collection getCollection()

Получить базовый набор данных пагинатора.

 из AbstractPaginator
$this setCollection(Collection $collection)

Установить базовый набор данных пагинатора.

 из AbstractPaginator
bool offsetExists(mixed $key)

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

 из AbstractPaginator
mixed offsetGet(mixed $key)

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

 из AbstractPaginator
void offsetSet(mixed $key, mixed $value)

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

 из AbstractPaginator
void offsetUnset(mixed $key)

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

 из AbstractPaginator
string toHtml()

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

 из AbstractPaginator
mixed __call(string $method, array $parameters)

Вызвать динамические методы набора данных.

 из AbstractPaginator
string __toString()

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

 из AbstractPaginator
void __construct(mixed $items, int $total, int $perPage, int|null $currentPage = null, array $options = [])

Создать новый экземпляр пагинатора.
int setCurrentPage(int $currentPage, string $pageName)

Получить текущую страницу для запроса.
HtmlString links(string|null $view = null, array $data = [])

Отобразить пагинатор с использованием заданного представления.
string render(string|null $view = null, array $data = [])

Отобразить пагинатор с использованием заданного представления.
array elements()

Получить массив элементов для передачи в представление.
int total()

Получить общее количество элементов, подлежащих пагинации.
bool hasMorePages()

Определить, есть ли еще элементы в источнике данных.
string|null nextPageUrl()

Получить URL для следующей страницы.
int lastPage()

Получить последнюю страницу.
array toArray()

Получить экземпляр в виде массива.
array jsonSerialize()

Преобразовать объект в сериализуемый в JSON формат.
string toJson(int $options)

Преобразовать объект в его представление в формате JSON.

Details

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.

Parameters

string|null $fragment

Return Value

$this|string|null

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

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

Parameters

array|string $key
string|null $value

Return Value

$this

protected $this appendArray(array $keys)

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

Parameters

array $keys

Return Value

$this

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

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

Parameters

string $key
string $value

Return Value

$this

protected string buildFragment()

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

Return Value

string

array items()

Получить фрагмент элементов, подлежащих пагинации.

Return Value

array

int firstItem()

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

Return Value

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

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)

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

Parameters

mixed $key

Return Value

mixed

void offsetSet(mixed $key, mixed $value)

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

Parameters

mixed $key
mixed $value

Return Value

void

void offsetUnset(mixed $key)

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

Parameters

mixed $key

Return Value

void

string toHtml()

Отобразить содержимое разделителя на HTML.

Return Value

string

mixed __call(string $method, array $parameters)

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

Parameters

string $method
array $parameters

Return Value

mixed

string __toString()

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

Return Value

string

void __construct(mixed $items, int $total, int $perPage, int|null $currentPage = null, array $options = [])

Создать новый экземпляр разделителя.

Parameters

mixed $items
int $total
int $perPage
int|null $currentPage
array $options (путь, запрос, фрагмент, имя страницы)

Return Value

void

protected int setCurrentPage(int $currentPage, string $pageName)

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

Parameters

int $currentPage
string $pageName

Return Value

int

HtmlString links(string|null $view = null, array $data = [])

Отобразить разделитель с помощью заданного представления.

Parameters

string|null $view
array $data

Return Value

HtmlString

string render(string|null $view = null, array $data = [])

Отобразить разделитель с помощью заданного представления.

Parameters

string|null $view
array $data

Return Value

string

protected array elements()

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

Return Value

array

int total()

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

Return Value

int

bool hasMorePages()

Определить, есть ли еще элементы в источнике данных.

Return Value

bool

string|null nextPageUrl()

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

Return Value

string|null

int lastPage()

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

Return Value

int

array toArray()

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

Return Value

array

array jsonSerialize()

Преобразовать объект в сериализуемый в JSON.

Return Value

array

string toJson(int $options)

Преобразовать объект в его представление JSON.

Parameters

int $options

Return Value

string

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.6/Illuminate/Pagination/LengthAwarePaginator.html

Spec-Zone.ru

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