Класс PaginatorHelper

Класс-помощник для упрощенного создания ссылок для пагинации.

PaginatorHelper содержит все необходимые методы для работы с пагинацией.

Пространство имён: Cake\View\Helper
Ссылка: https://book.cakephp.org/4/ru/views/helpers/paginator.html

Краткое описание свойств

$Form public @property

Cake\View\Helper\FormHelper
$Html public @property

Cake\View\Helper\HtmlHelper
$Number public @property

Cake\View\Helper\NumberHelper
$Url public @property

Cake\View\Helper\UrlHelper
$_View protected

Cake\View\View

Экземпляр класса View, к которому прикреплён этот помощник
$_config protected

array<string, mixed>

Конфигурация во время выполнения
$_configInitialized protected

bool

Признак того, что свойство config уже настроено по умолчанию
$_defaultConfig protected

array<string, mixed>

Конфигурация по умолчанию для этого класса
$_defaultModel protected

string|null

Модель по умолчанию для постраничного набора
$_helperMap protected

array<string, array>

Таблица поиска помощников, используемая для ленивой загрузки объектов помощников.
$_templater protected

Cake\View\StringTemplate|null

Экземпляр StringTemplate.
$helpers protected

array

Список помощников, используемых этим помощником

Краткое описание методов

__call() public

Обеспечивает некритичные ошибки при вызовах отсутствующих методов.
__construct() public

Конструктор. Переопределён для объединения переданных аргументов с параметрами URL.
__debugInfo() public

Возвращает массив, который может быть использован для описания внутреннего состояния этого объекта.
__get() public

Лениво загружает вспомогательные функции.
_configDelete() protected

Удаляет один ключ конфигурации.
_configRead() protected

Считывает значение ключа конфигурации.
_configWrite() protected

Записывает значение ключа конфигурации.
_confirm() protected

Возвращает строку, используемую в качестве обработчика onclick для диалогов подтверждения.
_firstNumber() protected

Генерирует первое число для метода paginator numbers().
_formatNumber() protected

Форматирует число для вывода в пагинаторе.
_getNumbersStartAndEnd() protected

Вычисляет начальное и конечное значения для страниц пагинации.
_hasPage() protected

Содержит ли $model страницу $page в своём диапазоне?
_lastNumber() protected

Генерирует последнее число для метода paginator numbers().
_modulusNumbers() protected

Генерирует числа для метода paginator numbers().
_numbers() protected

Генерирует числа для метода paginator numbers().
_removeAlias() protected

Удаляет псевдоним при необходимости.
_toggledLink() protected

Генерирует активную/неактивную ссылку для методов next/prev.
addClass() public

Добавляет указанный класс к опциям элемента.
configShallow() public

Объединяет предоставленную конфигурацию с существующей. В отличие от config(), который выполняет рекурсивное объединение для вложенных ключей, этот метод выполняет простое объединение.
counter() public

Возвращает строку счётчика для набора результатов с пагинацией.
current() public

Получает текущую страницу набора записей для заданной модели.
defaultModel() public

Получает или устанавливает модель по умолчанию для наборов с пагинацией.
first() public

Возвращает первое или набор чисел для первых страниц.
formatTemplate() public

Форматирует шаблонную строку с данными $data.
generateUrl() public

Объединяет переданные параметры URL с текущим состоянием пагинации для генерации URL пагинации.
generateUrlParams() public

Объединяет переданные параметры URL с текущим состоянием пагинации для генерации URL пагинации.
getConfig() public

Возвращает конфигурацию.
getConfigOrFail() public

Возвращает конфигурацию для данного ключа.
getTemplates() public

Получает шаблоны для использования или определённый шаблон.
getView() public

Получает экземпляр представления, к которому привязан этот помощник.
hasNext() public

Возвращает true, если заданный набор результатов не на последней странице.
hasPage() public

Возвращает true, если заданный набор результатов содержит страницу с номером $page.
hasPrev() public

Возвращает true, если заданный набор результатов не на первой странице.
implementedEvents() public

Обработчики событий.
initialize() public

Метод обработки инициализации.
last() public

Возвращает последнее или набор чисел для последних страниц.
limitControl() public

Выпадающий список для ограничения пагинации. Сгенерирует форму обёртки.
meta() public

Возвращает мета-ссылки для набора результатов с пагинацией.
next() public

Генерирует ссылку "следующая" для набора страниц записей.
numbers() public

Возвращает набор чисел для набора результатов с пагинацией. Использует модуль для определения, сколько чисел отображать по обе стороны от текущей страницы (по умолчанию: 8).
options() public

Устанавливает параметры по умолчанию для всех ссылок пагинации.
param() public

Удобный доступ к любому из параметров пагинатора.
params() public

Получает текущие параметры постраничного отображения из набора результатов для заданной модели.
prev() public

Генерирует ссылку "предыдущая" для набора страниц записей.
setConfig() public

Устанавливает конфигурацию.
setTemplates() public

Устанавливает шаблоны для использования.
sort() public

Генерирует ссылку сортировки. Устанавливает именованные параметры для сортировки и направления. Автоматически обрабатывает переключение направления.
sortDir() public

Получает текущее направление сортировки набора результатов.
sortKey() public

Получает текущий ключ, по которому сортируется набор результатов.

templater() public

Возвращает экземпляр шаблонизатора.
total() public

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

Подробное описание методов

__call() public

__call(string $method, array $params): mixed|void

Выдает некритичные ошибки при вызовах несуществующих методов.

Параметры

string $method: Метод для вызова
array $params: Массив параметров для метода.

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

mixed|void

__construct() public

__construct(Cake\View\View $view, array<string, mixed> $config = [])

Конструктор. Переопределен для слияния переданных аргументов с параметрами URL.

Параметры

Cake\View\View $view: Представление, к которому подключен этот помощник.
array<string, mixed> $config optional: Настройки конфигурации для помощника.

__debugInfo() public

__debugInfo(): array<string, mixed>

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

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

array<string, mixed>

__get() public

__get(string $name): Cake\View\Helper|null|void

Ленивая загрузка помощников.

Параметры

string $name: Имя свойства, к которому осуществляется доступ.

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

Cake\View\Helper|null|void

_configDelete() protected

_configDelete(string $key): void

Удаляет один ключ конфигурации.

Параметры

string $key: Ключ для удаления.

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

void

Исключения

Cake\Core\Exception\CakeException
при попытке перезаписать существующую конфигурацию

_configRead() protected

_configRead(string|null $key): mixed

Читает ключ конфигурации.

Параметры

string|null $key: Ключ для чтения.

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

mixed

_configWrite() protected

_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void

Записывает ключ конфигурации.

Параметры

array<string, mixed>|string $key: Ключ для записи.
mixed $value: Значение для записи.
string|bool $merge optional: True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

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

void

Исключения

Cake\Core\Exception\CakeException
при попытке перезаписать существующую конфигурацию

_confirm() protected

_confirm(string $okCode, string $cancelCode): string

Возвращает строку, которая будет использоваться в качестве обработчика onclick для диалоговых окон подтверждения.

Параметры

string $okCode: Код, который будет выполнен после того, как пользователь выбрал «OK»
string $cancelCode: Код, который будет выполнен после того, как пользователь выбрал «Отмена»

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

string

_firstNumber() protected

_firstNumber(string $ellipsis, array<string, mixed> $params, int $start, array<string, mixed> $options): string

Генерирует первое число для метода numbers() средства постраничной навигации.

Параметры

string $ellipsis: Символ многоточия.
array<string, mixed> $params: Параметры из метода numbers().
int $start: Начальное число.
array<string, mixed> $options: Параметры из метода numbers().

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

string

_formatNumber() protected

_formatNumber(Cake\View\StringTemplate $templater, array<string, mixed> $options): string

Форматирует число для вывода номеров страниц средства постраничной навигации.

Параметры

Cake\View\StringTemplate $templater: Экземпляр StringTemplate.
array<string, mixed> $options: Параметры из метода numbers().

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

string

_getNumbersStartAndEnd() protected

_getNumbersStartAndEnd(array<string, mixed> $params, array<string, mixed> $options): array

Вычисляет начало и конец для номеров страниц постраничной навигации.

Параметры

array<string, mixed> $params: Параметры из метода numbers().
array<string, mixed> $options: Параметры из метода numbers().

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

array

_hasPage() protected

_hasPage(string|null $model, string $dir): bool

Есть ли $page в диапазоне $model?

Параметры

string|null $model: Имя модели для получения параметров.
string $dir: Направление

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

bool

_lastNumber() protected

_lastNumber(string $ellipsis, array<string, mixed> $params, int $end, array<string, mixed> $options): string

Генерирует последнее число для метода numbers() средства постраничной навигации.

Параметры

string $ellipsis: Символ многоточия.
array<string, mixed> $params: Параметры из метода numbers().
int $end: Конечное число.
array<string, mixed> $options: Параметры из метода numbers().

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

string

_modulusNumbers() protected

_modulusNumbers(Cake\View\StringTemplate $templater, array<string, mixed> $params, array<string, mixed> $options): string

Генерирует номера для метода numbers() средства постраничной навигации.

Параметры

Cake\View\StringTemplate $templater: Экземпляр StringTemplate.
array<string, mixed> $params: Параметры из метода numbers().
array<string, mixed> $options: Параметры из метода numbers().

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

string

_numbers() protected

_numbers(Cake\View\StringTemplate $templater, array<string, mixed> $params, array<string, mixed> $options): string

Генерирует номера для метода numbers() средства постраничной навигации.

Параметры

Cake\View\StringTemplate $templater: Экземпляр StringTemplate.
array<string, mixed> $params: Параметры из метода numbers().
array<string, mixed> $options: Параметры из метода numbers().

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

string

_removeAlias() protected

_removeAlias(string $field, string|null $model = null): string

Удаляет псевдоним, если необходимо.

Параметры

string $field: Текущее поле
string|null $model optional: Текущий псевдоним модели

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

string

_toggledLink() protected

_toggledLink(string|false $text, bool $enabled, array<string, mixed> $options, array<string, mixed> $templates): string

Генерирует активную/неактивную ссылку для методов next/prev.

Параметры

string|false $text: Включенный текст для ссылки.
bool $enabled: Следует ли создавать включенную/отключенную версию.
array<string, mixed> $options: Массив параметров из вызывающего метода.
array<string, mixed> $templates: Массив шаблонов с ключами 'active' и 'disabled'.

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

string

addClass() public

addClass(array<string, mixed> $options, string $class, string $key = 'class'): array<string, mixed>

Добавляет заданный класс к параметрам элемента

Параметры

array<string, mixed> $options: Массив параметров/атрибутов, к которым нужно добавить класс
string $class: Добавляемое имя класса.
string $key optional: ключ для использования класса. По умолчанию 'class'.

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

array<string, mixed>

configShallow() public

configShallow(array<string, mixed>|string $key, mixed|null $value = null): $this

Объединить предоставленный конфиг с существующим конфигом. В отличие от config(), который выполняет рекурсивное объединение для вложенных ключей, этот метод выполняет простое объединение.

Установка определённого значения:

$this->configShallow('key', $value);

Установка вложенного значения:

$this->configShallow('some.nested.key', $value);

Обновление нескольких настроек конфига одновременно:

$this->configShallow(['one' => 'value', 'another' => 'value']);

Параметры

array<string, mixed>|string $key: Ключ для установки или массив с полным конфигом.
mixed|null $value optional: Значение для установки.

Возвращает

$this

counter() public

counter(string $format = 'pages', array<string, mixed> $options = []): string

Возвращает строку счётчика для набора результатов с постраничной навигацией.

Опции

model Модель для использования, по умолчанию PaginatorHelper::defaultModel();

Параметры

string $format optional: Строка формата, которую вы хотите использовать, по умолчанию 'pages', что генерирует вывод вроде '1 из 5'. Установите в 'range', чтобы сгенерировать вывод вроде '1 - 3 из 13'. Также может быть установлена в пользовательскую строку, содержащую следующие заполнитель {{page}}, {{pages}}, {{current}}, {{count}}, {{model}}, {{start}}, {{end}}, а также любое другое пользовательское содержимое.
array<string, mixed> $options optional: Опции для строки счётчика. См. раздел #options для списка ключей. Если строка, то она будет использована как формат.

Возвращает

string

Ссылки

https://book.cakephp.org/4/en/views/helpers/paginator.html#creating-a-page-counter

current() public

current(string|null $model = null): int

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

Параметры

string|null $model optional: Необязательное имя модели. Используется значение по умолчанию, если не указано.

Возвращает

int

Ссылки

https://book.cakephp.org/4/en/views/helpers/paginator.html#checking-the-pagination-state

defaultModel() public

defaultModel(string|null $model = null): string|null

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

Параметры

string|null $model optional: Имя модели для установки.

Возвращает

string|null

first() public

first(string|int $first = '<< first', array<string, mixed> $options = []): string

Возвращает первую страницу или набор чисел для первых страниц.

echo $this->Paginator->first('< first');

Создаёт ссылку на первую страницу. Ничего не выведет, если вы на первой странице.

echo $this->Paginator->first(3);

Создаст ссылки на первые 3 страницы, как только вы попадете на третью или последующую страницу. До этого ничего не будет выводиться.

Опции:

model Модель для использования, по умолчанию PaginatorHelper::defaultModel()
escape Нужно ли экранировать текст с помощью HTML.
url Массив дополнительных опций URL для генерации ссылок.

Параметры

string|int $first optional: Если строка, используйте её в качестве метки ссылки. Если число, то количество ссылок на страницы в начале диапазона.
array<string, mixed> $options optional: Массив опций.

Возвращает

string

Ссылки

https://book.cakephp.org/4/en/views/helpers/paginator.html#creating-jump-links

formatTemplate() public

formatTemplate(string $name, array<string, mixed> $data): string

Форматирует строку шаблона с помощью $data.

Параметры

string $name: Имя шаблона.
array<string, mixed> $data: Данные для вставки.

Возвращает

string

generateUrl() public

generateUrl(array<string, mixed> $options = [], string|null $model = null, array $url = [], array<string, mixed> $urlOptions = []): string

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

Опции URL:

escape: Если false, URL будет возвращён без экранирования, используйте только если вы его экранируете вручную перед отображением.
fullBase: Если true, к результату будет добавлен полный базовый URL.

Параметры

array<string, mixed> $options optional: Параметры постраничной навигации.
string|null $model optional: Модель, по которой нужно выполнить постраничную навигацию.
array $url optional: URL.
array<string, mixed> $urlOptions optional: Массив параметров.

Возвращает

string

Ссылки

https://book.cakephp.org/4/en/views/helpers/paginator.html#generating-pagination-urls

generateUrlParams() public

generateUrlParams(array<string, mixed> $options = [], string|null $model = null, array $url = []): array

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

Параметры

array<string, mixed> $options optional: Массив параметров постраничной навигации/URL.
string|null $model optional: Модель, по которой нужно выполнить постраничную навигацию.
array $url optional: URL.

Возвращает

array

getConfig() public

getConfig(string|null $key = null, mixed $default = null): mixed

Возвращает конфиг.

Использование

Чтение всего конфига:

$this->getConfig();

Чтение определённого значения:

$this->getConfig('key');

Чтение вложенного значения:

$this->getConfig('some.nested.key');

Чтение со значением по умолчанию:

$this->getConfig('some-key', 'default-value');

Параметры

string|null $key optional: Ключ для получения или null для получения всего конфига.
mixed $default optional: Возвращаемое значение, когда ключ не существует.

Возвращает

mixed

getConfigOrFail() public

getConfigOrFail(string $key): mixed

Возвращает конфиг для определённого ключа.

Значение конфига для этого ключа должно существовать, оно никогда не может быть null.

Параметры

string $key: Ключ для получения.

Возвращает

mixed

Выбрасывает

InvalidArgumentException

getTemplates() public

getTemplates(string|null $template = null): array|string

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

Параметры

string|null $template optional: Строка для чтения определённого шаблона, null для всех.

Возвращает

array|string

getView() public

getView(): Cake\View\View

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

Возвращает

Cake\View\View

hasNext() public

hasNext(string|null $model = null): bool

Возвращает true, если заданный набор результатов не на последней странице.

Параметры

string|null $model optional: Необязательное имя модели. Используется значение по умолчанию, если не указано.

Возвращает

bool

Ссылки

https://book.cakephp.org/4/en/views/helpers/paginator.html#checking-the-pagination-state

hasPage() public

hasPage(int $page = 1, string|null $model = null): bool

Возвращает true, если заданный набор результатов имеет номер страницы, указанный в $page

Параметры

int $page optional: Номер страницы — если не задан, по умолчанию равен 1.
string|null $model optional: Необязательное имя модели. Используется значение по умолчанию, если не указано.

Возвращает

bool

Исключения

InvalidArgumentException

Ссылки

https://book.cakephp.org/4/ru/views/helpers/paginator.html#checking-the-pagination-state

hasPrev() public

hasPrev(string|null $model = null): bool

Возвращает true, если заданный набор результатов не находится на первой странице

Параметры

string|null $model optional: Необязательное имя модели. Используется значение по умолчанию, если не указано.

Возвращает

bool

Ссылки

https://book.cakephp.org/4/ru/views/helpers/paginator.html#checking-the-pagination-state

implementedEvents() public

implementedEvents(): array<string, mixed>

Обработчики событий.

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

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

Возвращает

array<string, mixed>

initialize() public

initialize(array<string, mixed> $config): void

Метод обработки конструктора.

Реализуйте этот метод, чтобы избежать необходимости перезаписывать конструктор и вызывать родительский метод.

Параметры

array<string, mixed> $config: Настройки конфигурации, предоставленные этому помощнику.

Возвращает

void

last() public

last(string|int $last = 'last >>', array<string, mixed> $options = []): string

Возвращает последнюю или набор чисел для последних страниц.

echo $this->Paginator->last('last >');

Создаёт единственную ссылку для последней страницы. Выведет ничего, если вы на последней странице.

echo $this->Paginator->last(3);

Создаст ссылки для последних 3 страниц. После вхождения в диапазон страниц, ничего не выведет.

Параметры:

model Модель для использования по умолчанию PaginatorHelper::defaultModel()
escape Нужно ли кодировать текст в HTML.
url Массив дополнительных параметров URL для использования при генерации ссылок.

Параметры

string|int $last optional: Если строка, используется как метка для ссылки, если число, отображаются номера страниц
array<string, mixed> $options optional: Массив параметров

Возвращает

string

Ссылки

https://book.cakephp.org/4/ru/views/helpers/paginator.html#creating-jump-links

limitControl() public

limitControl(array<string, string> $limits = [], int|null $default = null, array<string, mixed> $options = []): string

Выпадающий список для ограничения постраничной выборки. Это сгенерирует форму обрамления.

Параметры

array<string, string> $limits optional: Массив параметров.
int|null $default optional: Значение по умолчанию для ограничения постраничной выборки. По умолчанию $this->param('perPage').
array<string, mixed> $options optional: Параметры для атрибутов тега Select, такие как class, id или event

Возвращает

string

meta() public

meta(array<string, mixed> $options = []): string|null

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

echo $this->Paginator->meta();

Выводит ссылки напрямую, ничего не выведет, если нет ни предыдущей, ни следующей страницы.

$this->Paginator->meta(['block' => true]);

Добавит вывод функции meta в указанный блок — если передано true, используется блок "meta".

Параметры:

model Модель для использования по умолчанию PaginatorHelper::defaultModel()
block Имя блока для добавления вывода, или false/отсутствие для возвращения как строки
prev (по умолчанию True) True для генерации мета для предыдущей страницы
next (по умолчанию True) True для генерации мета для следующей страницы
first (по умолчанию False) True для генерации мета для первой страницы
last (по умолчанию False) True для генерации мета для последней страницы

Параметры

array<string, mixed> $options optional: Массив параметров

Возвращает

string|null

next() public

next(string $title = 'Next >>', array<string, mixed> $options = []): string

Генерирует ссылку "следующая" для набора страниц записей.

Параметры:

disabledTitle Текст, используемый, когда ссылка отключена. По умолчанию такой же, как у активной ссылки. Установка в false приведет к тому, что этот метод вернёт ''.
escape Нужно ли кодировать содержимое в HTML-сущности, по умолчанию true
model Используемая модель, по умолчанию PaginatorHelper::defaultModel()
url Массив дополнительных параметров URL для использования при генерации ссылок.
templates Массив шаблонов или имя файла шаблона, содержащие шаблоны, которые вы хотели бы использовать при генерации ссылки для следующей страницы. Исходные шаблоны помощника будут восстановлены после завершения next().

Параметры

string $title optional: Заголовок ссылки. По умолчанию 'Далее >>'.
array<string, mixed> $options optional: Параметры постраничной ссылки. См. список ключей выше.

Возвращает

string

Ссылки

https://book.cakephp.org/4/ru/views/helpers/paginator.html#creating-jump-links

numbers() public

numbers(array<string, mixed> $options = []): string

Возвращает набор чисел для набора результатов на страницах, использует модуль, чтобы решить, сколько чисел отобразить с каждой стороны текущей страницы (по умолчанию: 8).

$this->Paginator->numbers(['first' => 2, 'last' => 2]);

Используя параметры first и last, вы можете создавать ссылки на начало и конец набора страниц.

Параметры

before Содержимое, которое будет вставлено перед числами, но после первой ссылки.
after Содержимое, которое будет вставлено после чисел, но перед последней ссылкой.
model Модель для создания номеров, по умолчанию PaginatorHelper::defaultModel()
modulus Количество чисел, включаемых по обе стороны от текущей страницы, по умолчанию 8. Установите в false чтобы отключить и отобразить все числа.
first Нужно ли генерировать ссылки на первую страницу, установите целое число, чтобы определить количество ссылок «первая» для генерации. Если установлена строка, ссылка на первую страницу будет сгенерирована со значением в качестве заголовка.
last Нужно ли генерировать ссылки на последнюю страницу, установите целое число, чтобы определить количество ссылок «последняя» для генерации. Если установлена строка, ссылка на последнюю страницу будет сгенерирована со значением в качестве заголовка.
templates Массив шаблонов или имя файла шаблона, содержащие шаблоны, которые вы хотели бы использовать при генерации чисел. Исходные шаблоны помощника будут восстановлены после завершения numbers().
url Массив дополнительных параметров URL для использования при генерации ссылок.

Сгенерированные числовые ссылки включат шаблон «многоточие», когда параметры first и last и количество страниц превысят модуль. Например, если у вас 25 страниц, и вы используете параметры first/last и модуль 8, содержимое многоточия будет вставлено после наборов первой и последней ссылки.

Параметры

array<string, mixed> $options optional: Параметры для чисел.

Возвращает

string

Ссылки

https://book.cakephp.org/4/ru/views/helpers/paginator.html#creating-page-number-links

options() public

options(array<string, mixed> $options = []): void

Устанавливает параметры по умолчанию для всех ссылок постраничной навигации

Параметры

array<string, mixed> $options optional: Параметры по умолчанию для ссылок постраничной навигации. См. PaginatorHelper::$options для списка ключей.

Возвращает

void

param() public

param(string $key, string|null $model = null): mixed

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

Параметры

string $key: Ключ массива параметров постраничной навигации для извлечения.
string|null $model optional: Необязательное имя модели. Используется значение по умолчанию, если не указано.

Возвращает

mixed

params() public

params(string|null $model = null): array

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

Параметры

string|null $model optional: Необязательное имя модели. Используется значение по умолчанию, если не указано.

Возвращает

array

prev() public

prev(string $title = '<< Previous', array<string, mixed> $options = []): string

Генерирует ссылку "предыдущая" для набора постраничных записей.

Опции:

disabledTitle Текст, используемый при отключённой ссылке. По умолчанию совпадает с текстом активной ссылки. Установка в false вернёт пустую строку.
escape Требуется ли кодирование HTML-сущностей содержимого, по умолчанию true
model Используемая модель, по умолчанию PaginatorHelper::defaultModel()
model Массив дополнительных опций URL для генерации ссылки.
templates Массив шаблонов или имя файла шаблона, содержащий шаблоны, которые нужно использовать при генерации ссылки на предыдущую страницу. Исходные шаблоны помощника будут восстановлены после выполнения prev().

Параметры

string $title optional: Заголовок для ссылки. По умолчанию «<< Предыдущая».
array<string, mixed> $options optional: Опции для ссылки постраничной навигации. Список ключей см. выше.

Возвращает

string

Ссылки

https://book.cakephp.org/4/ru/views/helpers/paginator.html#creating-jump-links

setConfig() public

setConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $this

Устанавливает конфигурацию.

Использование

Установление определённого значения:

$this->setConfig('key', $value);

Установка вложенного значения:

$this->setConfig('some.nested.key', $value);

Обновление нескольких настроек конфигурации одновременно:

$this->setConfig(['one' => 'value', 'another' => 'value']);

Параметры

array<string, mixed>|string $key: Ключ для установки или полный массив конфигураций.
mixed|null $value optional: Значение для установки.
bool $merge optional: Рекурсивное слияние или перезапись существующей конфигурации, по умолчанию true.

Возвращает

$this

Исключения

Cake\Core\Exception\CakeException
При попытке установить недопустимый ключ.

setTemplates() public

setTemplates(array<string> $templates): $this

Устанавливает используемые шаблоны.

Параметры

array<string> $templates: Добавляемые шаблоны.

Возвращает

$this

sort() public

sort(string $key, array<string, mixed>|string|null $title = null, array<string, mixed> $options = []): string

Генерирует ссылку сортировки. Устанавливает именованные параметры для сортировки и направления. Автоматически обрабатывает переключение направления.

Опции:

escape Требуется ли кодирование HTML-сущностей содержимого, по умолчанию true.
model Используемая модель, по умолчанию PaginatorHelper::defaultModel().
direction Направление по умолчанию, если эта ссылка не активна.
lock Заблокировать направление. Использует только направление по умолчанию, по умолчанию false.

Параметры

string $key: Имя ключа, по которому должен быть отсортирован набор записей.
array<string, mixed>|string|null $title optional: Заголовок для ссылки. Если $title равен null, $key будет использован для заголовка и сгенерирован с помощью inflection. Также может быть массивом с ключами asc и desc для указания отдельных заголовков, основанных на направлении.
array<string, mixed> $options optional: Опции для ссылки сортировки. Список ключей см. выше.

Возвращает

string

Ссылки

https://book.cakephp.org/4/ru/views/helpers/paginator.html#creating-sort-links

sortDir() public

sortDir(string|null $model = null, array<string, mixed> $options = []): string

Получает текущее направление сортировки набора записей.

Параметры

string|null $model optional: Необязательное имя модели. Используется значение по умолчанию, если не указано.
array<string, mixed> $options optional: Опции для ссылок постраничной навигации.

Возвращает

string

Ссылки

https://book.cakephp.org/4/ru/views/helpers/paginator.html#creating-sort-links

sortKey() public

sortKey(string|null $model = null, array<string, mixed> $options = []): string|null

Получает текущий ключ, по которому отсортирован набор записей.

Параметры

string|null $model optional: Необязательное имя модели. Используется значение по умолчанию, если не указано.
array<string, mixed> $options optional: Опции для ссылок постраничной навигации.

Возвращает

string|null

Ссылки

https://book.cakephp.org/4/ru/views/helpers/paginator.html#creating-sort-links

templater() public

templater(): Cake\View\StringTemplate

Возвращает экземпляр templater.

Возвращает

Cake\View\StringTemplate

total() public

total(string|null $model = null): int

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

Параметры

string|null $model optional: Необязательное имя модели. Используется значение по умолчанию, если не указано.

Возвращает

int

Подробное описание свойств

`$Form` public @property

Тип

Cake\View\Helper\FormHelper

`$Html` public @property

Тип

Cake\View\Helper\HtmlHelper

`$Number` public @property

Тип

Cake\View\Helper\NumberHelper

`$Url` public @property

Тип

Cake\View\Helper\UrlHelper

`$_View` protected

Экземпляр View, к которому прикреплён этот помощник

Тип

Cake\View\View

`$_config` protected

Конфигурация во время выполнения

Тип

array<string, mixed>

`$_configInitialized` protected

Установлена ли конфигурация свойств значениями по умолчанию

Тип

bool

`$_defaultConfig` protected

Конфигурация по умолчанию для этого класса

Параметры: Содержит значения по умолчанию для ссылок постраничной навигации

Возможные значения:

url URL действия. См. Router::url()
url['?']['sort'] ключ, по которому сортируется набор записей.
url['?']['direction'] направление сортировки (по умолчанию: 'asc').
url['?']['page'] Номер страницы для использования в ссылках.
model Имя модели.
escape Определяет, нужно ли экранировать поле заголовка для ссылки (по умолчанию: true).
routePlaceholders Массив, определяющий, какие параметры постраничной навигации должны передаваться в качестве параметров маршрута, а не параметров запроса. Массив может содержать значения 'sort', 'direction', 'page'.

Шаблоны: шаблоны, используемые этим классом

Тип

array<string, mixed>

`$_defaultModel` protected

Модель по умолчанию наборов страниц

Тип

string|null

`$_helperMap` protected

Таблица поиска помощников, используемая для ленивой загрузки объектов помощников.

Тип

array<string, array>

`$_templater` protected

Экземпляр StringTemplate.

Тип

Cake\View\StringTemplate|null

`$helpers` protected

Список помощников, используемых этим помощником

Тип

array

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.3/class-Cake.View.Helper.PaginatorHelper.html