Класс PaginatorHelper

__constructsource public

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

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

Параметры

Cake\View\View $View

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

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

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

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

Cake\View\Helper::__construct()

_firstNumbersource protected

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

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

Параметры

Cake\View\StringTemplate $ellipsis

Экземпляр StringTemplate.

массив $params

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

целое $start

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

массив $options

Опции из метода numbers().

Возвращает

string
Вывод разметки.

_formatNumbersource protected

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

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

Параметры

Cake\View\StringTemplate $templater

Экземпляр StringTemplate.

массив $options

Опции из метода numbers().

Возвращает

string
строка

_getNumbersStartAndEndsource protected

_getNumbersStartAndEnd( array $params , array $options )

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

Параметры

массив $params

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

массив $options

Опции из метода numbers().

Возвращает

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

_hasPagesource protected

_hasPage( string $model , integer $page )

Является ли $model частью диапазона $page?

Параметры

строка $model

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

целое $page

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

Возвращает

boolean
Принадлежит ли модель к $page

_lastNumbersource protected

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

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

Параметры

Cake\View\StringTemplate $ellipsis

Экземпляр StringTemplate.

массив $params

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

целое $end

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

массив $options

Опции из метода numbers().

Возвращает

string
Вывод разметки.

_modulusNumberssource protected

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

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

Параметры

Cake\View\StringTemplate $templater

Экземпляр StringTemplate.

массив $params

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

массив $options

Опции из метода numbers().

Возвращает

string
Вывод разметки.

_numberssource protected

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

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

Параметры

Cake\View\StringTemplate $templater

Экземпляр StringTemplate.

массив $params

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

массив $options

Опции из метода numbers().

Возвращает

string
Вывод разметки.

_toggledLinksource protected

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

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

Параметры

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

Текст ссылки для активного состояния.

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

Нужно ли создавать версию активного/неактивного состояния?

массив $options

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

массив $templates

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

Возвращает

string
Сгенерированный HTML

countersource 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 для списка ключей. Если строка, будет использоваться в качестве формата.

Возвращает

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

Ссылка

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

currentsource public

current( string|null $model null )

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

Параметры

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

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

Возвращает

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

Ссылка

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

defaultModelsource public

defaultModel( )

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

Возвращает

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

firstsource 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 для генерации ссылок.

Параметры

string|integer $first необязательно '<< first'

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

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

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

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

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

Ссылка

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

generateUrlsource public

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

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

Параметры

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

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

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

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

boolean $full необязательно false

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

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

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

Ссылка

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

hasNextsource public

hasNext( 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

hasPagesource public

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

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

Параметры

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

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

integer $page необязательно 1

Номер страницы. Если не указано, по умолчанию 1.

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

boolean
True, если заданный результат содержит указанную страницу.

Ссылка

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

hasPrevsource 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

implementedEventssource public

implementedEvents( )

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

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

array
массив

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

Cake\View\Helper::implementedEvents()

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

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

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

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

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

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

Ссылка

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

metasource 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
Мета-ссылки

nextsource public

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

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

Параметры:

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

Параметры

string $title необязательно 'Next >>'

Заголовок ссылки. По умолчанию 'Next >>'.

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

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

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

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

Ссылка

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

numberssource 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, содержимое многоточия будет вставлено после наборов ссылок первой и последней страниц.

Параметры

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

Параметры для чисел.

Возвращает

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

Ссылка

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

optionssource public

options( array $options [] )

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

Параметры

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

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

paramsource public

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

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

Параметры

строка $key

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

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

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

Возвращает

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

paramssource public

params( string|null $model null )

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

Параметры

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

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

Возвращает

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

prevsource public

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

Генерирует ссылку «предыдущая» для набора записей, разделенных на страницы.

Параметры:

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

Параметры

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

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

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

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

Возвращает

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

Ссылка

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

sortsource 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 будет использован для заголовка и сгенерирован с помощью inflection.

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

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

Возвращает

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

Ссылка

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

sortDirsource public

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

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

Параметры

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

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

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

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

Возвращает

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

Ссылка

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

sortKeysource public

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

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

Параметры

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

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

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

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

Возвращает

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

Ссылка

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

__callsource public

__call( string $method , array $params )

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

Параметры

строка $method

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

массив $params

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

__debugInfosource public

__debugInfo( )

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

Возвращает

array
массив

__getsource public

__get( string $name )

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

Параметры

string $name

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

Возвращает

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

_confirmsource protected

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

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

Параметры

string $message

Сообщение, которое будет отображено

string $okCode

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

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

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

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

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

Возвращает

string
JS-код onclick

addClasssource public

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

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

Параметры

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

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

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

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

string $key необязательно 'class'

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

Возвращает

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

formatTemplatesource public

formatTemplate( string $name , array $data )

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

Параметры

string $name

Имя шаблона.

array $data

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

Возвращает

string
строка

templatersource public

templater( )

templater

Возвращает

Cake\View\StringTemplate
\Cake\View\StringTemplate

templatessource public

templates( string|null|array $templates null )

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

Параметры

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

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

Возвращает

mixed
$this|строка|массив

_configDeletesource protected

_configDelete( string $key )

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

Параметры

string $key

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

Исключения

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

_configReadsource protected

_configRead( string|null $key )

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

Параметры

string|null $key

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

Возвращает

mixed
смешанное

_configWritesource 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
если пытаетесь перезаписать существующую конфигурацию

configsource 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
При попытке установить недействительный ключ.

configShallowsource 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

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

Возвращает

mixed
Объект $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']

[]

[]

null

null

[]

null

[]

false