Spec-Zone.ru › Laravel 10

AbstractPaginator

абстрактный класс AbstractPaginator реализует Htmlable mixin Collection (View source)

Свойства

ForwardsCalls
Tappable

Свойства

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

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

int $onEachSide

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

protected array $options

Параметры постраничного отображения.

static protected Closure $currentPathResolver

Обратный вызов для получения текущего пути.

static protected Closure $currentPageResolver

Обратный вызов для получения текущей страницы.

static protected Closure $queryStringResolver

Обратный вызов для получения строки запроса.

static protected Closure $viewFactoryResolver

Обратный вызов для получения фабрики представлений.

static string $defaultView

Предпочтительное представление постраничного отображения.

static string $defaultSimpleView

Предпочтительное представление простого постраничного отображения.

Методы

mixed forwardCallTo(mixed $object, string $method, array $parameters)

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

из ForwardsCalls
mixed forwardDecoratedCallTo(mixed $object, string $method, array $parameters)

Передать вызов метода заданному объекту, возвращая $this, если переданный вызов вернул себя.

из ForwardsCalls
static void throwBadMethodCallException(string $method)

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

из ForwardsCalls
$this|HigherOrderTapProxy tap(callable|null $callback = null)

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

из Tappable
bool isValidPageNumber(int $page)

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

string|null previousPageUrl()

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

array getUrlRange(int $start, int $end)

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

string url(int $page)

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

$this|string|null fragment(string|null $fragment = null)

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

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

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

$this appendArray(array $keys)

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

$this withQueryString()

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

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

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

string buildFragment()

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

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

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

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

Загрузить набор подсчетов отношений в коллекцию смешанных отношений.

array items()

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

int|null firstItem()

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

int|null lastItem()

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

$this through(callable $callback)

Преобразовать каждый элемент в части элементов с помощью обратного вызова.

int perPage()

Получить количество элементов, отображаемых на странице.

bool hasPages()

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

bool onFirstPage()

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

bool onLastPage()

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

int currentPage()

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

string getPageName()

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

$this setPageName(string $name)

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

$this withPath(string $path)

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

$this setPath(string $path)

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

$this onEachSide(int $count)

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

string|null path()

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

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 string resolveQueryString(string|array|null $default = null)

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

static void queryStringResolver(Closure $resolver)

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

static Factory viewFactory()

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

static void viewFactoryResolver(Closure $resolver)

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

static void defaultView(string $view)

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

static void defaultSimpleView(string $view)

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

static void useTailwind()

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

static void useBootstrap()

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

static void useBootstrapThree()

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

static void useBootstrapFour()

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

static void useBootstrapFive()

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

Traversable getIterator()

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

bool isEmpty()

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

bool isNotEmpty()

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

int count()

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

Collection getCollection()

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

$this setCollection(Collection $collection)

Установить базовый набор элементов пагинатора.

array getOptions()

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

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 mixed forwardCallTo(mixed $object, string $method, array $parameters)

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

Parameters

mixed $object
string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

protected mixed forwardDecoratedCallTo(mixed $object, string $method, array $parameters)

Перенаправить вызов метода на заданный объект, возвращая $this, если перенаправленный вызов вернул сам себя.

Parameters

mixed $object
string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

static protected void throwBadMethodCallException(string $method)

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

Parameters

string $method

Return Value

void

Exceptions

BadMethodCallException

$this|HigherOrderTapProxy tap(callable|null $callback = null)

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

Parameters

callable|null $callback

Return Value

$this|HigherOrderTapProxy

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|null $key, string|null $value = null)

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

Parameters

array|string|null $key
string|null $value

Return Value

$this

protected $this appendArray(array $keys)

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

Parameters

array $keys

Return Value

$this

$this withQueryString()

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

Return Value

$this

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

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

Parameters

string $key
string $value

Return Value

$this

protected string buildFragment()

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

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

string

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

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

Параметры

string $relation
array $relations

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

$this

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

Загрузить набор подсчетов отношений в коллекцию смешанных отношений.

Параметры

string $relation
array $relations

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

$this

array items()

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

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

array

int|null firstItem()

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

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

int|null

int|null lastItem()

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

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

int|null

$this through(callable $callback)

Преобразовать каждый элемент в фрагменте с помощью обратного вызова.

Параметры

callable $callback

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

$this

int perPage()

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

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

int

bool hasPages()

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

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

bool

bool onFirstPage()

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

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

bool

bool onLastPage()

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

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

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

string|null path()

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

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

string|null

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 string resolveQueryString(string|array|null $default = null)

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

Параметры

string|array|null $default

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

string

static void queryStringResolver(Closure $resolver)

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

Параметры

Closure $resolver

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

void
END_OF_DOCUMENT_MARKER

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

static void useTailwind()

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

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

void

static void useBootstrap()

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

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

void

static void useBootstrapThree()

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

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

void

static void useBootstrapFour()

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

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

void

static void useBootstrapFive()

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

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

void

Traversable getIterator()

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

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

Traversable

bool isEmpty()

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

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

bool

bool isNotEmpty()

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

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

bool

int count()

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

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

int

Collection getCollection()

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

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

Collection

$this setCollection(Collection $collection)

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

Параметры

Collection $collection

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

$this

array getOptions()

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

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

array

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

Spec-Zone.ru

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