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

Генерирует первое число для метода paginator 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 )

Генерирует последнее число для метода paginator 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( )

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

Возвращает

строка|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 , boolean $full false )

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

Параметры

массив $options по желанию []

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

строка|null $model по желанию null

Наименование модели для постраничной навигации

логическое $full по желанию false

Если true, полный базовый URL будет добавлен в результат

Возвращает

строка
По умолчанию возвращает полную строку 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 Нужно ли генерировать ссылки на первую страницу, устанавливается в целое число для определения количества ссылок 'first'. Если устанавливается строка, генерируется ссылка на первую страницу со значением в качестве заголовка.
• last Нужно ли генерировать ссылки на последнюю страницу, устанавливается в целое число для определения количества ссылок 'last'. Если устанавливается строка, генерируется ссылка на последнюю страницу со значением в качестве заголовка.
• templates Массив шаблонов или имя файла шаблона, содержащие шаблоны, которые вы хотите использовать при генерации номеров. Исходные шаблоны помощника будут восстановлены после завершения numbers().
• url Массив дополнительных параметров URL для генерации ссылок.

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

Параметры

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.
• model Модель для использования, по умолчанию PaginatorHelper::defaultModel().
• direction Направление по умолчанию для использования, когда эта ссылка не активна.
• lock Заблокировать направление. Будет использоваться только направление по умолчанию, по умолчанию — false.

Параметры

строка $key

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

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

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

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

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

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

строка

Ссылка для сортировки по умолчанию '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 [] )

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

Параметры

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

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

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

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

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

строка

Направление, по которому сортируется выборка, или 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 [] )

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

Параметры

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

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

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

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

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

строка|null

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

Ссылка

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

__call()source public

__call( string $method , array $params )

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

Параметры

строка $method

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

массив $params

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

__debugInfo()source public

__debugInfo( )

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

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

массив

__get()source public

__get( string $name )

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

Параметры

строка $name

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

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

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

_confirm()source protected

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

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

Параметры

строка $message

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

строка $okCode

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

строка $cancelCode необязательно ''

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

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

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

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

строка
JS-код onclick

addClass()source public

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

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

Параметры

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

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

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

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

строка $key необязательно 'class'

Ключ для использования класса.

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

массив
Массив параметров с установленным $key.

initialize()source public

initialize( array $config )

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

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

Параметры

массив $config

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

_configDelete()source protected

_configDelete( string $key )

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

Параметры

строка $key

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

Исключения

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

_configRead()source protected

_configRead( string|null $key )

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

Параметры

строка|null $key

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

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

смешанный

_configWrite()source protected

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

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

Параметры

строка|массив $key

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

смешанный $value

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

булево|строка $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']);

Параметры

строка|массив|null $key необязательно null

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

смешанный|null $value необязательно null

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

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

Выполнять ли рекурсивное объединение или перезапись существующей конфигурации, по умолчанию — true.

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

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

Исключения

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']);

Параметры

строка|массив $key

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

смешанный|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']