Класс PaginatorHelper

__construct()source public

__construct( View $View , array $settings array() )

Конструктор helper. Настраивает helper, используемый для создания ссылок «AJAX».

Используйте public $helpers = array('Paginator' => array('ajax' => 'CustomHelper')); для установки пользовательского Helper или выбора Helper отличного от JsHelper. Если вы хотите использовать определённую библиотеку с JsHelper, объявите JsHelper и его адаптер перед включением PaginatorHelper в массив helpers.

Выбранный пользовательский helper должен реализовывать метод link().

Параметры

View $View

объект представления, к которому прикреплён helper.

массив $settings опционально array()

Массив настроек.

Исключения

CakeException
Когда helper AjaxProvider не реализует метод link.

_convertUrlKeys()source protected

_convertUrlKeys( array $url , string $type )

Преобразует используемые ключи в формат, установленный параметром options.paramType

Параметры

массив $url

Массив параметров URL для преобразования

строка $type

Тип ключей.

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

массив
преобразованные параметры URL.

_hasPage()source protected

_hasPage( string $model , integer $page )

Находится ли $page в диапазоне $model?

Параметры

строка $model

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

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

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

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

булево
Принадлежит ли $page к диапазону модели

_pagingLink()source protected

_pagingLink( string $which , string $title null , array $options array() , string $disabledTitle null , array $disabledOptions array() )

Защищённый метод для генерации ссылок «предыдущая»/«следующая»

Параметры

строка $which

Тип ссылки: «Предыдущая», «Следующая».

строка $title опционально null

Заголовок ссылки.

массив $options опционально array()

Список опций.

строка $disabledTitle опционально null

Заголовок ссылки по умолчанию.

массив $disabledOptions опционально array()

Опции для ссылки по умолчанию.

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

строка

beforeRender()source public

beforeRender( string $viewFile )

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

Параметры

строка $viewFile

Имя файла представления.

counter()source public

counter( array $options array() )

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

Параметры

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

Плейсхолдеры стиля %page% также работают, но устарели и будут удалены в будущей версии.

Параметры

массив $options необязательно array()

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

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

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

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/paginator.html#PaginatorHelper::counter

current()source public

current( string $model null )

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

Параметры

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

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

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

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

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/paginator.html#PaginatorHelper::current

defaultModel()source public

defaultModel( string|null $model null )

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

Параметры

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

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

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

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

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/paginator.html#PaginatorHelper::defaultModel

first()source public

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

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

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

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

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

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

Параметры:

• tag Тэг для обертки, по умолчанию 'span'
• after Содержимое, вставляемое после ссылки/тэга
• model Модель для использования, по умолчанию PaginatorHelper::defaultModel()
• separator Содержимое между сгенерированными ссылками, по умолчанию ' | '
• ellipsis Содержимое для многоточия, по умолчанию '...'

Параметры

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

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

массив $options необязательно array()

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

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

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

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/paginator.html#PaginatorHelper::first

hasNext()source public

hasNext( string $model null )

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

Параметры

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

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

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

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

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/paginator.html#PaginatorHelper::hasNext

hasPage()source public

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

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

Параметры

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

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

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

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

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

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

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/paginator.html#PaginatorHelper::hasPage

hasPrev()source public

hasPrev( string $model null )

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

Параметры

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

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

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

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

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/paginator.html#PaginatorHelper::hasPrev

last()source public

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

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

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

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

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

Создаст ссылки на последние 3 страницы. После попадания в диапазон страниц, вывода не будет.

Параметры:

• tag Тэг для обертки, по умолчанию 'span'
• before Содержимое, вставляемое перед ссылкой/тэгом
• model Модель для использования, по умолчанию PaginatorHelper::defaultModel()
• separator Содержимое между сгенерированными ссылками, по умолчанию ' | '
• ellipsis Содержимое для многоточия, по умолчанию '...'

Параметры

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

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

массив $options необязательно array()

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

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

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

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/paginator.html#PaginatorHelper::last

link()source public

link( string $title , string|array $url array() , array $options array() )

Генерирует простую или Ajax ссылку с параметрами постраничной навигации

Параметры

• update Идентификатор DOM элемента, который вы хотите обновить. Создаёт ссылки, поддерживающие Ajax, с помощью AjaxHelper.
• escape Требуется ли кодирование содержимого в HTML сущности, по умолчанию true
• model Модель для использования, по умолчанию PaginatorHelper::defaultModel()

Параметры

строка $title

Заголовок для ссылки.

строка|массив $url необязательно array()

URL для действия. См. Router::url()

массив $options необязательно array()

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

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

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

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/paginator.html#PaginatorHelper::link

meta()source public

meta( array $options array() )

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

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

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

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

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

Параметры:

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

Параметры

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

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

Возвращает

строка|null
Мета-ссылки.

next()source public

next( string $title 'Next >>' , array $options array() , string $disabledTitle null , array $disabledOptions array() )

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

Параметры:

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

Параметры

строка $title необязательно 'Далее >>'

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

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

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

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

Заголовок, когда ссылка отключена.

массив $disabledOptions необязательно массив()

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

Возвращает

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

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/paginator.html#PaginatorHelper::next

numbers()source public

numbers( array|boolean $options array() )

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

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

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

Параметры

• before Содержимое, которое будет вставлено перед числами
• after Содержимое, которое будет вставлено после чисел
• model Модель для создания чисел, по умолчанию PaginatorHelper::defaultModel()
• modulus количество чисел, включаемых по обе стороны от текущей страницы, по умолчанию 8.
• separator Разделитель, по умолчанию ' | '
• tag Тег, которым нужно обернуть ссылки, по умолчанию 'span'
• first Необходимо ли генерировать ссылки на первую страницу, задается целым числом для определения количества ссылок 'first' для генерации. Если задана строка, будет сгенерирована ссылка на первую страницу с заданным значением в качестве заголовка.
• last Необходимо ли генерировать ссылки на последнюю страницу, задается целым числом для определения количества ссылок 'last' для генерации. Если задана строка, будет сгенерирована ссылка на последнюю страницу с заданным значением в качестве заголовка.
• ellipsis Содержимое многоточия, по умолчанию '...'
• class Класс для тега обертки
• currentClass Класс для тега обертки на текущей активной странице, по умолчанию 'current'
• currentTag Тег для текущего номера страницы, по умолчанию null

Параметры

массив|логическое значение $options необязательно массив()

Параметры для чисел, (перед, после, модель, модуль, разделитель)

Возвращает

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

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/paginator.html#PaginatorHelper::numbers

options()source public

options( array|string $options array() )

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

Параметры

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

Параметры по умолчанию для ссылок постраничной навигации. Если передана строка - она используется в качестве элемента id DOM для обновления. См. PaginatorHelper::$options для списка ключей.

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/paginator.html#PaginatorHelper::options

param()source public

param( string $key , string $model null )

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

Параметры

строка $key

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

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

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

Возвращает

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

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/paginator.html#PaginatorHelper::params

params()source public

params( string $model null )

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

Параметры

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

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

Возвращает

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

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/paginator.html#PaginatorHelper::params

prev()source public

prev( string $title '<< Previous' , array $options array() , string $disabledTitle null , array $disabledOptions array() )

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

Параметры:

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

Параметры

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

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

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

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

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

Заголовок, когда ссылка отключена.

массив $disabledOptions необязательно массив()

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

Возвращает

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

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/paginator.html#PaginatorHelper::prev

sort()source public

sort( string $key , string $title null , array $options array() )

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

Параметры:

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

Параметры

строка $key

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

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

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

массив $options необязательно array()

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

Возвращает

строку

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

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/paginator.html#PaginatorHelper::sort

sortDir()source public

sortDir( string $model null , array $options array() )

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

Параметры

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

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

массив $options необязательно array()

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

Возвращает

строка

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

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/paginator.html#PaginatorHelper::sortDir

sortKey()source public

sortKey( string $model null , array $options array() )

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

Параметры

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

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

массив $options необязательно array()

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

Возвращает

строка|null

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

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/paginator.html#PaginatorHelper::sortKey

url()source public

url( array $options array() , boolean $asArray false , string $model null )

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

Параметры

массив $options необязательно array()

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

булево $asArray необязательно false

Возвратить URL в виде массива или строки URI

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

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

Возвращает

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

Ссылка

https://book.cakephp.org/2.0/ru/core-libraries/helpers/paginator.html#PaginatorHelper::url

'Js'

array('Html')

array(
    'convertKeys' => array('page', 'limit', 'sort', 'direction')
)