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) Определить, является ли заданное значение допустимым номером страницы.	from AbstractPaginator
string\|null	previousPageUrl() Получить URL предыдущей страницы.	from AbstractPaginator
array	getUrlRange(int $start, int $end) Создать диапазон URL страниц для пагинации.	from AbstractPaginator
string	url(int $page) Получить URL для заданного номера страницы.	from AbstractPaginator
$this\|string\|null	fragment(string\|null $fragment = null) Получить/установить фрагмент URL для добавления к URL.	from AbstractPaginator
$this	appends(array\|string $key, string\|null $value = null) Добавить набор значений параметров запроса к пагинатору.	from AbstractPaginator
$this	appendArray(array $keys) Добавить массив значений параметров запроса.	from AbstractPaginator
$this	addQuery(string $key, string $value) Добавить значение параметра запроса к пагинатору.	from AbstractPaginator
string	buildFragment() Сформировать полную часть фрагмента URL.	from AbstractPaginator
array	items() Получить срез элементов, подлежащих пагинации.	from AbstractPaginator
int	firstItem() Получить номер первого элемента в срезе.	from AbstractPaginator
int	lastItem() Получить номер последнего элемента в срезе.	from AbstractPaginator
int	perPage() Получить количество элементов на странице.	from AbstractPaginator
bool	hasPages() Определить, достаточно ли элементов для разделения на несколько страниц.	from AbstractPaginator
bool	onFirstPage() Определить, находится ли пагинатор на первой странице.	from AbstractPaginator
int	currentPage() Получить текущую страницу.	from AbstractPaginator
string	getPageName() Получить имя переменной строки запроса, используемой для хранения страницы.	from AbstractPaginator
$this	setPageName(string $name) Установить имя переменной строки запроса, используемой для хранения страницы.	from AbstractPaginator
$this	withPath(string $path) Установить базовый путь, который нужно назначить всем URL.	from AbstractPaginator
$this	setPath(string $path) Установить базовый путь, который нужно назначить всем URL.	from AbstractPaginator
static string	resolveCurrentPath(string $default = '/') Разрешить текущий путь запроса или вернуть значение по умолчанию.	from AbstractPaginator
static void	currentPathResolver(Closure $resolver) Установить обратный вызов для разрешения текущего пути запроса.	from AbstractPaginator
static int	resolveCurrentPage(string $pageName = 'page', int $default = 1) Разрешить текущую страницу или вернуть значение по умолчанию.	from AbstractPaginator
static void	currentPageResolver(Closure $resolver) Установить обратный вызов для разрешения текущей страницы.	from AbstractPaginator
static Factory	viewFactory() Получить экземпляр фабрики представлений из решателя.	from AbstractPaginator
static void	viewFactoryResolver(Closure $resolver) Установить обратный вызов для разрешения фабрики представлений.	from AbstractPaginator
static void	defaultView(string $view) Установить представление по умолчанию для пагинации.	from AbstractPaginator
static void	defaultSimpleView(string $view) Установить представление по умолчанию для "простого" пагинации.	from AbstractPaginator
ArrayIterator	getIterator() Получить итератор для элементов.	from AbstractPaginator
bool	isEmpty() Определить, пуст ли список элементов или нет.	from AbstractPaginator
int	count() Получить количество элементов для текущей страницы.	from 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) Получить текущую страницу для запроса.
string	links(string $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.

Подробности

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

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

Return Value

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

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

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

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

Параметры

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

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

void

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

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

Параметры

int	$currentPage
string	$pageName

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

int

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

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

Параметры

string	$view
array	$data

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

string

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

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

Параметры

string\|null	$view
array	$data

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

string

protected array elements()

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

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

array

int total()

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

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

int

bool hasMorePages()

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

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

bool

string|null nextPageUrl()

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

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

string|null

int lastPage()

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

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

int

array toArray()

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

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

array

array jsonSerialize()

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

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

array

string toJson(int $options)

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

Параметры

int

$options

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

string

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