Класс PaginatorHelper

__construct()source public

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

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

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

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

Параметры

View $View

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

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

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

Исключения

CakeException
Если помощник AjaxProvider не реализует метод link.

_convertUrlKeys()source protected

_convertUrlKeys( array $url , string $type )

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

Параметры

массив $url

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

строка $type

Тип ключей.

Возвращает

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

_hasPage()source protected

_hasPage( string $model , integer $page )

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

Параметры

строка $model

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

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

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

Возвращает

логическое значение
Содержит ли модель страницу $page.

_pagingLink()source protected

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

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

Параметры

строка $which

Тип ссылки: 'Prev', 'Next'.

строка $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()

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

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

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

Ссылка

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

current()source public

current( string $model null )

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

Параметры

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

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

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

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

Ссылка

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

defaultModel()source public

defaultModel( )

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

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

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

Ссылка

http://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()

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

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

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

Ссылка

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

hasNext()source public

hasNext( string $model null )

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

Параметры

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

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

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

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

Ссылка

http://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, если не задан.

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

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

Ссылка

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

hasPrev()source public

hasPrev( string $model null )

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

Параметры

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

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

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

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

Ссылка

http://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()

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

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

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

Ссылка

http://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 ID элемента DOM, который нужно обновить. Создаёт Ajax-активированные ссылки с помощью AjaxHelper.
• escape Нужно ли кодировать содержимое в HTML-сущности, по умолчанию true
• model Модель для использования, по умолчанию PaginatorHelper::defaultModel()

Параметры

строка $title

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

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

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

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

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

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

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

Ссылка

http://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));

Добавит вывод функции мета в указанный блок — если передано 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, если ссылка отключена.

Ссылка

http://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 Нужно ли генерировать ссылки на первую страницу, устанавливается в целое число для определения количества ссылок на 'первую' страницу. Если установлено строковое значение, будет сгенерирована ссылка на первую страницу со значением в качестве заголовка.
• last Нужно ли генерировать ссылки на последнюю страницу, устанавливается в целое число для определения количества ссылок на 'последнюю' страницу. Если установлено строковое значение, будет сгенерирована ссылка на последнюю страницу со значением в качестве заголовка.
• ellipsis Содержимое многоточия, по умолчанию '...'
• class Класс для тега-обёртки
• currentClass Класс для тега-обёртки текущей активной страницы, по умолчанию 'current'
• currentTag Тег для использования для номера текущей страницы, по умолчанию null

Параметры

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

Параметры для чисел (before, after, model, modulus, separator)

Возвращает

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

Ссылка

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

options()source public

options( array|string $options array() )

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

Параметры

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

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

Ссылка

http://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

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

Возвращает

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

Ссылка

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

params()source public

params( string $model null )

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

Параметры

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

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

Возвращает

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

Ссылка

http://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, если ссылка отключена.

Ссылка

http://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, и он будет сгенерирован с помощью инфлексии.

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

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

Возвращает

строка

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

Ссылка

http://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 необязательно массив()

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

Возвращает

строка

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

Ссылка

http://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 необязательно массив()

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

Возвращает

строка|null

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

Ссылка

http://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 необязательно массив()

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

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

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

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

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

Возвращает

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

Ссылка

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

'Js'

array('Html')

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