AbstractPaginator
абстрактный класс AbstractPaginator реализует Htmlable, Stringable микшин 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 |
| tap($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 | использоватьBootstrapFive()
Указать, что для сгенерированных ссылок следует использовать стили 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)
Перенаправить вызов метода на заданный объект.
protected mixed forwardDecoratedCallTo(mixed $object, string $method, array $parameters)
Перенаправить вызов метода на заданный объект, вернув $this, если перенаправленный вызов вернул сам себя.
static protected void throwBadMethodCallException(string $method)
Выбросить исключение BadMethodCall для заданного метода.
tap($callback = null)
Вызвать заданный Closure с этим экземпляром, а затем вернуть экземпляр.
protected 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)
Добавить набор значений параметров запроса к пагинатору.
protected $this appendArray(array $keys)
Добавить массив значений параметров запроса.
$this withQueryString()
Добавить все текущие значения параметров запроса к пагинатору.
protected $this addQuery(string $key, string $value)
Добавить значение параметра запроса к пагинатору.
protected 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()
Вывести содержимое пагинатора при приведении к строке.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Pagination/AbstractPaginator.html