Класс PaginatorHelper

__construct()source public

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

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

Параметры

Cake\View\View $View

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

массив $config необязательный []

Параметры конфигурации помощника.

Переопределяет

Cake\View\Helper::__construct()

_firstNumber()source protected

_firstNumber( Cake\View\StringTemplate $ellipsis , array $params , integer $start , array $options )

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

Параметры

Cake\View\StringTemplate $ellipsis

Экземпляр StringTemplate.

массив $params

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

целое число $start

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

массив $options

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

Возвращает

Строка
Результат вывода разметки.

_formatNumber()source protected

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

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

Параметры

Cake\View\StringTemplate $templater

Экземпляр StringTemplate.

массив $options

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

Возвращает

Строка

_getNumbersStartAndEnd()source protected

_getNumbersStartAndEnd( array $params , array $options )

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

Параметры

массив $params

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

массив $options

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

Возвращает

Массив
Массив с начальным и конечным числом.

_hasPage()source protected

_hasPage( string $model , integer $page )

Принадлежит ли $model странице $page в своём диапазоне?

Параметры

строка $model

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

целое число $page

Номер страницы, которую вы проверяете.

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

boolean
Является ли модель $page

_lastNumber()source protected

_lastNumber( Cake\View\StringTemplate $ellipsis , array $params , integer $end , array $options )

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

Параметры

Cake\View\StringTemplate $ellipsis

Экземпляр StringTemplate.

массив $params

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

целое число $end

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

массив $options

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

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

строка
Выходные данные разметки.

_modulusNumbers()source protected

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

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

Параметры

Cake\View\StringTemplate $templater

Экземпляр StringTemplate.

массив $params

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

массив $options

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

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

строка
Выходные данные разметки.

_numbers()source protected

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

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

Параметры

Cake\View\StringTemplate $templater

Экземпляр StringTemplate.

массив $params

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

массив $options

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

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

строка
Выходные данные разметки.

_toggledLink()source protected

_toggledLink( string|boolean $text , boolean $enabled , array $options , array $templates )

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

Параметры

строка|логическое $text

Текст, который будет отображаться, когда ссылка активна.

логическое $enabled

Требуется ли создавать активную/неактивную версию.

массив $options

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

массив $templates

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

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

строка
Сгенерированный HTML

counter()source public

counter( string|array $options [] )

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

Параметры

• model Используемая модель, по умолчанию PaginatorHelper::defaultModel();
• format Форматная строка, которую вы хотите использовать, по умолчанию 'pages'. Возвращает вывод типа '1 из 5'. Установите 'range' для вывода типа '1 - 3 из 13'. Также можно установить пользовательскую строку, содержащую следующие плейсхолдеры {{page}}, {{pages}}, {{current}}, {{count}}, {{model}}, {{start}}, {{end}} и любой другой пользовательский контент.

Параметры

строка|массив $options необязательно []

Параметры для строки счётчика. См. #options для списка ключей. Если строка, будет использоваться в качестве формата.

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

строка
Строка счётчика.

Ссылка

http://book.cakephp.org/3.0/ru/views/helpers/paginator.html#creating-a-page-counter

current()source public

current( string|null $model null )

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

Параметры

строка|null $model необязательно null

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

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

целое число
Номер текущей страницы набора записей.

Ссылка

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

defaultModel()source public

defaultModel( string|null $model null )

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

Параметры

строка|null $model необязательно null

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

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

строка|null
Имя модели или null, если пагинация не инициализирована.

first()source public

first( string|integer $first '<< first' , array $options [] )

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

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

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

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

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

Параметры:

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

Параметры

строка|целое число $first необязательно '<< first'

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

массив $options необязательно []

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

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

строка
Строка с номерами.

Ссылка

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

generateUrl()source public

generateUrl( array $options [] , string|null $model null , array|boolean $urlOptions false )

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

Параметры URL:

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

Параметры

массив $options необязательно []

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

строка|null $model необязательно null

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

массив|логическое $urlOptions необязательно false

Массив параметров или логическое значение fullBase для совместимости.

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

строка
По умолчанию возвращает полную строку URL пагинации для использования в нестандартных контекстах (например, JavaScript)

Ссылка

http://book.cakephp.org/3.0/ru/views/helpers/paginator.html#generating-pagination-urls

hasNext()source public

hasNext( string|null $model null )

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

Параметры

строка|null $model необязательно null

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

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

логическое
True, если набор результатов не на последней странице.

Ссылка

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

hasPage()source public

hasPage( string|null $model null , integer $page 1 )

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

Параметры

строка|null $model необязательно null

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

целое число $page необязательно 1

Номер страницы. По умолчанию 1.

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

логическое
True, если заданный набор результатов содержит указанный номер страницы.

Ссылка

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

hasPrev()source public

hasPrev( string|null $model null )

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

Параметры

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

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

Возвращает

boolean
True, если результат не на первой странице.

Ссылка

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

implementedEvents()source public

implementedEvents( )

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

Возвращает

array

Переопределяет

Cake\View\Helper::implementedEvents()

last()source public

last( string|integer $last 'last >>' , array $options [] )

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

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

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

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

Создаст ссылки на последние 3 страницы. Как только вы войдёте в диапазон страниц, вывод не будет создан.

Опции:

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

Параметры

string|integer $last необязательно 'последняя >>'

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

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

Массив опций

Возвращает

string
строка чисел.

Ссылка

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

meta()source public

meta( array $options [] )

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

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

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

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

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

Опции:

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

Параметры

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

Массив опций

Возвращает

string|null
Мета-ссылки

next()source public

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

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

Опции:

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

Параметры

string $title необязательно 'Следующая >>'

Заголовок для ссылки. По умолчанию 'Следующая >>'.

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

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

Возвращает

string
Ссылка "следующая" или текст $disabledTitle, если ссылка отключена.

Ссылка

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

numbers()source public

numbers( array $options [] )

Возвращает набор чисел для набора результатов с постраничным выводом использует модуль, чтобы решить, сколько чисел отображать по обе стороны от текущей страницы (по умолчанию: 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, содержимое «многоточие» будет вставлено после наборов ссылок first и last.

Параметры

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

Опции для номеров.

Возвращает

string
строка чисел.

Ссылка

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

options()source public

options( array $options [] )

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

Параметры

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

Параметры по умолчанию для ссылок постраничного вывода. Список ключей см. в PaginatorHelper::$options.

param()source public

param( string $key , string|null $model null )

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

Параметры

string $key

Ключ массива параметров постраничного вывода для извлечения.

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

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

Возвращает

mixed
Содержимое запрошенного параметра.

params()source public

params( string|null $model null )

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

Параметры

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

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

Возвращает

array
Массив параметров постраничного вывода для набора результатов с постраничным выводом.

prev()source public

prev( string $title '<< Previous' , array $options [] )

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

Опции:

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

Параметры

string $title необязательно 'Предыдущая <<'

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

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

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

Возвращает

string
Ссылка "предыдущая" или ссылка, отмеченная как отключенная.

Ссылка

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

sort()source public

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

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

Параметры:

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

Параметры

string $key

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

string|null $title опционально null

Текст для ссылки. Если $title равен null, используется $key для заголовка и генерируется с помощью инфлексии.

array $options опционально []

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

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

string

Ссылка для сортировки по умолчанию по возрастанию ('asc'). Если результат отсортирован по возрастанию ('asc') по указанному ключу, возвращаемая ссылка будет сортироваться по убыванию ('desc').

Ссылка

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

sortDir()source public

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

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

Параметры

string|null $model опционально null

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

array $options опционально []

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

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

string

Направление сортировки выборки записей или null, если результаты не отсортированы.

Ссылка

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

sortKey()source public

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

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

Параметры

string|null $model опционально null

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

array $options опционально []

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

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

string|null

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

Ссылка

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

__call()source public

__call( string $method , array $params )

Обеспечивает обработку ошибок при отсутствии вызова метода.

Параметры

string $method

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

array $params

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

__debugInfo()source public

__debugInfo( )

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

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

array

__get()source public

__get( string $name )

Ленизагружает хелперы.

Параметры

string $name

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

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

Cake\View\Helper|null
Экземпляр хелпера, если хелпер с указанным именем существует

_confirm()source protected

_confirm( string $message , string $okCode , string $cancelCode '' , array $options [] )

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

Параметры

string $message

Сообщение для отображения

string $okCode

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

string $cancelCode опционально ''

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

array $options опционально []

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

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

string
JS-код onclick

addClass()source public

addClass( array $options [] , string|null $class null , string $key 'class' )

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

Параметры

array $options опционально []

Массив параметров/атрибутов, к которым нужно добавить класс.

string|null $class опционально null

Имя добавляемого класса.

string $key опционально 'class'

Ключ, используемый для класса.

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

array
Массив параметров со значением $key.

initialize()source public

initialize( array $config )

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

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

Параметры

array $config

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

formatTemplate()source public

formatTemplate( string $name , array $data )

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

Параметры

string $name

Имя шаблона.

array $data

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

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

string

templater()source public

templater( )

templater

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

Cake\View\StringTemplate

templates()source public

templates( string|null|array $templates null )

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

Параметры

string|null|array $templates опционально null

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

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

$this|string|array

_configDelete()source protected

_configDelete( string $key )

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

Параметры

string $key

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

Возбуждает

Cake\Core\Exception\Exception
если производится попытка переопределения существующей конфигурации

_configRead()source protected

_configRead( string|null $key )

Чтение переменной конфигурации.

Параметры

string|null $key

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

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

mixed

_configWrite()source protected

_configWrite( string|array $key , mixed $value , boolean|string $merge false )

Запись переменной конфигурации.

Параметры

string|array $key

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

mixed $value

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

boolean|string $merge опционально false

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

Возбуждает

Cake\Core\Exception\Exception
если производится попытка переопределения существующей конфигурации

config()source public

config( string|array|null $key null , mixed|null $value null , boolean $merge true )

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

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

$this->config();

Чтение конкретного значения:

$this->config('key');

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

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

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

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

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

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

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

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

Параметры

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

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

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

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

boolean $merge необязательно true

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

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

mixed
Значение конфигурации, которое читается, или сам объект при операциях записи.

Исключения

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

configShallow()source public

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

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

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

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

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

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

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

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

Параметры

string|array $key

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

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

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

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

$this Сам объект.

[
    'options' => [],
    'templates' => [
        'nextActive' => '<li class="next"><a rel="next" href="{{url}}">{{text}}</a></li>',
        'nextDisabled' => '<li class="next disabled"><a href="" onclick="return false;">{{text}}</a></li>',
        'prevActive' => '<li class="prev"><a rel="prev" href="{{url}}">{{text}}</a></li>',
        'prevDisabled' => '<li class="prev disabled"><a href="" onclick="return false;">{{text}}</a></li>',
        'counterRange' => '{{start}} - {{end}} of {{count}}',
        'counterPages' => '{{page}} of {{pages}}',
        'first' => '<li class="first"><a href="{{url}}">{{text}}</a></li>',
        'last' => '<li class="last"><a href="{{url}}">{{text}}</a></li>',
        'number' => '<li><a href="{{url}}">{{text}}</a></li>',
        'current' => '<li class="active"><a href="">{{text}}</a></li>',
        'ellipsis' => '<li class="ellipsis">...</li>',
        'sort' => '<a href="{{url}}">{{text}}</a>',
        'sortAsc' => '<a class="asc" href="{{url}}">{{text}}</a>',
        'sortDesc' => '<a class="desc" href="{{url}}">{{text}}</a>',
        'sortAscLocked' => '<a class="asc locked" href="{{url}}">{{text}}</a>',
        'sortDescLocked' => '<a class="desc locked" href="{{url}}">{{text}}</a>',
    ]
]

['Url', 'Number', 'Html']