LengthAwarePaginator

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

Свойства

ForwardsCalls

Свойства

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
int	$onEachSide	Количество ссылок, отображаемых по обе стороны от ссылки текущей страницы.	из AbstractPaginator
static protected Closure	$currentPathResolver	Обработчик текущего пути.	из AbstractPaginator

static protected Closure	$currentPageResolver	Обратный вызов текущего решателя страницы.	from AbstractPaginator
static protected Closure	$viewFactoryResolver	Обратный вызов решателя фабрики представлений.	from AbstractPaginator
static string	$defaultView	Представление по умолчанию для постраничной навигации.	from AbstractPaginator
static string	$defaultSimpleView	Представление по умолчанию для "простого" отображения постраничной навигации.	from AbstractPaginator
protected int	$total	Общее количество элементов до разделения.
protected int	$lastPage	Последняя доступная страница.

Методы

mixed	forwardCallTo(mixed $object, string $method, array $parameters) Перенаправить вызов метода заданному объекту.	from ForwardsCalls
static void	throwBadMethodCallException(string $method) Выбросить исключение плохого вызова метода для данного метода.	from ForwardsCalls
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
$this	loadMorph(string $relation, array $relations) Загрузить набор отношений к смешанной коллекции отношений.	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

$this	onEachSide(int $count) Установите количество ссылок для отображения по обе стороны текущей страницы.	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
static void	useBootstrapThree() Указать, что следует использовать стили Bootstrap 3 для сгенерированных ссылок.	from AbstractPaginator
ArrayIterator	getIterator() Получить итератор для элементов.	from AbstractPaginator
bool	isEmpty() Определить, пуст ли список элементов.	from AbstractPaginator
bool	isNotEmpty() Определить, не пуст ли список элементов.	from AbstractPaginator

int	count() Получить количество элементов для текущей страницы.	from AbstractPaginator
Collection	getCollection() Получить базовый набор данных пагинатора.	from AbstractPaginator
$this	setCollection(Collection $collection) Установить базовый набор данных пагинатора.	from AbstractPaginator
bool	offsetExists(mixed $key) Определить, существует ли данный элемент.	from AbstractPaginator
mixed	offsetGet(mixed $key) Получить элемент по заданному смещению.	from AbstractPaginator
void	offsetSet(mixed $key, mixed $value) Установить элемент по заданному смещению.	from AbstractPaginator
void	offsetUnset(mixed $key) Удалить элемент по заданному ключу.	from AbstractPaginator

строка	toHtml() Отобразить содержимое пагинатора в HTML.	из AbstractPaginator
смешанный тип	__call(строка $method, массив $parameters) Выполнять динамические вызовы в коллекцию.	из AbstractPaginator
строка	__toString() Отобразить содержимое пагинатора при приведении к строке.	из AbstractPaginator
void	__construct(смешанный тип $items, целое число $total, целое число $perPage, целое число\|null $currentPage = null, массив $options = []) Создать новый экземпляр пагинатора.
целое число	setCurrentPage(целое число $currentPage, строка $pageName) Получить текущую страницу для запроса.
HtmlString	links(строка\|null $view = null, массив $data = []) Отобразить пагинатор с использованием заданного представления.
строка	render(строка\|null $view = null, массив $data = []) Отобразить пагинатор с использованием заданного представления.
массив	elements() Получить массив элементов для передачи в представление.
целое число	total() Получить общее количество элементов, подлежащих пагинации.
логическое значение	hasMorePages() Определить, есть ли больше элементов в источнике данных.

строка\|null	nextPageUrl() Получить URL следующей страницы.
целое число	lastPage() Получить последнюю страницу.
массив	toArray() Получить экземпляр в виде массива.
массив	jsonSerialize() Преобразовать объект в сериализуемый JSON.
строка	toJson(int $options = 0) Преобразовать объект в его JSON представление.

Подробности

protected смешанный forwardCallTo(смешанный $object, строка $method, массив $parameters)

Перенаправить вызов метода на заданный объект.

Параметры

смешанный	$object
строка	$method
массив	$parameters

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

смешанный

Исключения

BadMethodCallException

static protected пустое значение throwBadMethodCallException(строка $method)

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

Параметры

строка

$method

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

пустое значение

Исключения

BadMethodCallException

protected bool isValidPageNumber(int $page)

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

Параметры

int

$page

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

bool

string|null previousPageUrl()

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

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

string|null

array getUrlRange(int $start, int $end)

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

Параметры

int	$start
int	$end

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

array

string url(int $page)

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

Параметры

int

$page

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

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

$this loadMorph(string $relation, array $relations)

Загрузить набор отношений к смешанной коллекции отношений.

Параметры

string	$relation
array	$relations

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

$this

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

$this onEachSide(int $count)

Установите количество ссылок, отображаемых по обе стороны от ссылки текущей страницы.

Параметры

int

$count

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

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

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

Parameters

Closure

$resolver

Return Value

void

static void defaultView(string $view)

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

Parameters

string

$view

Return Value

void

static void defaultSimpleView(string $view)

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

Parameters

string

$view

Return Value

void

static void useBootstrapThree()

Указать, что для сгенерированных ссылок должен использоваться стиль Bootstrap 3.

Return Value

void

ArrayIterator getIterator()

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

Return Value

ArrayIterator

bool isEmpty()

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

Return Value

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

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

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

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

Параметры

string\|null	$view
array	$data

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

HtmlString

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 = 0)

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

Параметры

int

$options

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

string

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