Spec-Zone.ru › CakePHP 4.2

Класс 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

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

  • $_configInitialized protected
    bool

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

  • $_defaultConfig protected
    array

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

  • $_defaultModel protected
    string|null

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

  • $_helperMap protected
    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

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

Parameters

string $method

Метод для вызова

array $params

Массив параметров для метода.

Returns

mixed|void

__construct() public 

__construct(Cake\View\View $view, array $config = [])

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

Parameters

Cake\View\View $view

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

array $config optional

Настройки конфигурации для помощника.

__debugInfo() public 

__debugInfo(): array

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

Returns

array

__get() public 

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

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

Parameters

string $name

Имя доступаемого свойства.

Returns

Cake\View\Helper|null|void

_configDelete() protected 

_configDelete(string $key): void

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

Parameters

string $key

Ключ для удаления.

Returns

void

Throws

Cake\Core\Exception\CakeException
if attempting to clobber existing config

_configRead() protected 

_configRead(string|null $key): mixed

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

Parameters

string|null $key

Ключ для чтения.

Returns

mixed

_configWrite() protected 

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

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

Parameters

string|array $key

Ключ для записи.

mixed $value

Значение для записи.

bool|string $merge optional

True для рекурсивного слияния, 'shallow' для простого слияния, false для перезаписи, по умолчанию false.

Returns

void

Throws

Cake\Core\Exception\CakeException
if attempting to clobber existing config

_confirm() protected 

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

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

Parameters

string $okCode

Код, который будет выполнен после того, как пользователь выбрал «OK»

string $cancelCode

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

Returns

string

_firstNumber() protected 

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

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

Parameters

string $ellipsis

Символ многоточия.

array $params

Параметры из метода numbers().

int $start

Начальное число.

array $options

Параметры из метода numbers().

Returns

string

_formatNumber() protected 

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

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

Parameters

Cake\View\StringTemplate $templater

Экземпляр StringTemplate.

array $options

Параметры из метода numbers().

Returns

string

_getNumbersStartAndEnd() protected 

_getNumbersStartAndEnd(array $params, array $options): array

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

Parameters

array $params

Параметры из метода numbers().

array $options

Параметры из метода numbers().

Returns

array

_hasPage() protected 

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

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

Parameters

string|null $model

Имя модели для получения параметров.

string $dir

Направление

Returns

bool

_lastNumber() protected 

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

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

Parameters

string $ellipsis

Символ многоточия.

array $params

Параметры из метода numbers().

int $end

Конечное число.

array $options

Параметры из метода numbers().

Returns

string

_modulusNumbers() protected 

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

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

Parameters

Cake\View\StringTemplate $templater

Экземпляр StringTemplate.

array $params

Параметры из метода numbers().

array $options

Параметры из метода numbers().

Returns

string

_numbers() protected 

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

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

Parameters

Cake\View\StringTemplate $templater

Экземпляр StringTemplate.

array $params

Параметры из метода numbers().

array $options

Параметры из метода numbers().

Returns

string

_removeAlias() protected 

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

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

Parameters

string $field

Текущее поле

string|null $model optional

Текущий псевдоним модели

Returns

string

_toggledLink() protected 

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

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

Parameters

string|false $text

Включенный текст для ссылки.

bool $enabled

Следует ли создавать включенную/выключенную версию.

array $options

Массив параметров из вызывающего метода.

array $templates

Массив шаблонов с ключами 'active' и 'disabled'.

Returns

string

addClass() public 

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

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

Parameters

array $options

Массив параметров/атрибутов для добавления класса

string $class

Добавляемое имя класса.

string $key optional

ключ для использования класса. По умолчанию 'class'.

Returns

array

configShallow() public 

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

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

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

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

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

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

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

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

Параметры

string|array $key

Ключ для установки или массив конфигураций.

mixed|null $value необязательно

Значение для установки.

Возвращает

$this

counter() public 

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

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

Параметры

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

Параметры

string $format необязательно

Строка формата, которую вы хотите использовать, по умолчанию 'pages'. Она генерирует вывод типа '1 из 5'. Установите 'range', чтобы сгенерировать вывод типа '1 - 3 из 13'. Также можно установить пользовательскую строку, содержащую следующие заполнитель {{page}}, {{pages}}, {{current}}, {{count}}, {{model}}, {{start}}, {{end}}, и любой дополнительный текст.

array $options необязательно

Параметры для строки счётчика. Смотрите раздел #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 необязательно

Необязательное имя модели. Используется значение по умолчанию, если не указано.

Возвращает

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 необязательно

Имя модели для установки

Возвращает

string|null

first() public 

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

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

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

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

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

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

Параметры:

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

Параметры

string|int $first необязательно

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

array $options необязательно

Массив параметров.

Возвращает

string

Ссылки

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

formatTemplate() public 

formatTemplate(string $name, array $data): string

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

Параметры

string $name

Имя шаблона.

array $data

Данные для вставки.

Возвращает

string

generateUrl() public 

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

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

Параметры URL:

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

Параметры

array $options необязательно

Параметры постраничной навигации.

string|null $model необязательно

Модель, по которой нужно выполнить постраничную навигацию.

array $url необязательно

URL.

array $urlOptions необязательно

Массив параметров.

Возвращает

string

Ссылки

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

generateUrlParams() public 

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

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

Параметры

array $options необязательно

Массив параметров постраничной навигации/URL.

string|null $model необязательно

Модель, по которой нужно выполнить постраничную навигацию.

array $url необязательно

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 необязательно

Ключ для получения или null для всей конфигурации.

mixed $default необязательно

Возвращаемое значение, если ключ не существует.

Возвращает

mixed

getConfigOrFail() public 

getConfigOrFail(string $key): mixed

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

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

Параметры

string $key

Ключ для получения.

Возвращает

mixed

Выбрасывает

InvalidArgumentException

getTemplates() public 

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

Получает используемые шаблоны или конкретный шаблон.

Параметры

string|null $template необязательно

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

Возвращает

string|array

getView() public 

getView(): Cake\View\View

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

Возвращает

Cake\View\View

hasNext() public 

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

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

Параметры

string|null $model необязательно

Необязательное имя модели. Используется значение по умолчанию, если не указано.

Возвращает

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

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

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

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

Возвращает

array

initialize() public 

initialize(array $config): void

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

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

Параметры

array $config

Настройки конфигурации, предоставленные этому помощнику.

Возвращает

void

last() public 

last(string|int $last = 'last >>', array $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 $options optional

Массив опций

Возвращает

string

Ссылки

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

limitControl() public 

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

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

Параметры

array $limits optional

Массив опций.

int|null $default optional

Значение по умолчанию для ограничения постраничной выборки. По умолчанию $this->param('perPage').

array $options optional

Параметры для атрибутов тега Select, такие как class, id или event

Возвращает

string

meta() public 

meta(array $options = []): string|null

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

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

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

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

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

Опции:

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

Параметры

array $options optional

Массив опций

Возвращает

string|null

next() public 

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

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

Опции:

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

Параметры

string $title optional

Название для ссылки. По умолчанию 'Далее >>'.

array $options optional

Опции для ссылки на страницу. См. выше список ключей.

Возвращает

string

Ссылки

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

numbers() public 

numbers(array $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 $options optional

Опции для чисел.

Возвращает

string

Ссылки

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

options() public 

options(array $options = []): void

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

Параметры

array $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 $options = []): string

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

Опции:

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

Параметры

string $title optional

Заголовок для ссылки. По умолчанию «<< Предыдущая».

array $options optional

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

Возвращает

string

Ссылки

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

setConfig() public 

setConfig(string|array $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']);

Параметры

string|array $key

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

mixed|null $value optional

Значение для установки.

bool $merge optional

Рекурсивное слияние или перезапись существующей конфигурации, по умолчанию true.

Возвращает

$this

Исключения

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

setTemplates() public 

setTemplates(string[] $templates): $this

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

Параметры

string[] $templates

Добавляемые шаблоны.

Возвращает

$this

sort() public 

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

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

Опции:

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

Параметры

string $key

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

string|array|null $title optional

Заголовок для ссылки. Если $title равен null, $key будет использован для заголовка и сгенерирован с помощью inflection. Также может быть массивом с ключами asc и desc для указания отдельных заголовков, основанных на направлении.

array $options optional

Опции для ссылки сортировки. Список ключей см. выше.

Возвращает

string

Ссылки

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

sortDir() public 

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

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

Параметры

string|null $model optional

Необязательное имя модели. Используется значение по умолчанию, если не указано.

array $options optional

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

Возвращает

string

Ссылки

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

sortKey() public 

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

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

Параметры

string|null $model optional

Необязательное имя модели. Используется значение по умолчанию, если не указано.

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

$_configInitialized protected

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

Тип

bool

$_defaultConfig protected

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

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

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

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

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

Тип

array

$_defaultModel protected

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

Тип

string|null

$_helperMap protected

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

Тип

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.2/class-Cake.View.Helper.PaginatorHelper.html

Spec-Zone.ru

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