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

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

Helper::__construct()

_convertUrlKeys()source protected

_convertUrlKeys( array $url , string $type )

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

Параметры

массив $url

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

строка $type

Тип ключей.

Возвращает

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

_hasPage()source protected

_hasPage( string $model , integer $page )

Есть ли у модели $page в допустимом диапазоне?

Параметры

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

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

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

Helper::beforeRender()

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

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

Возвращает

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

Ссылка

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

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

Возвращает

булево
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.

Возвращает

булево
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

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

Возвращает

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

Параметры

строка $title

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

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

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

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

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

Возвращает

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

Ссылка

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

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

Ссылка

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

Параметры

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

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

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

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

Ссылка

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

options()source public

options( array|string $options array() )

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

Параметры

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

Параметры по умолчанию для ссылок на постраничную навигацию. Если передается строка, она используется как идентификатор элемента DOM для обновления. См. 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 )

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

Параметры

строка $key

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

строка $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 необязательный массив()

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

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

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

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

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

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

строка
Ссылка "предыдущая" или текст $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 необязательно array()

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

Возвращает

строка

Ссылка на сортировку по умолчанию '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 необязательно array()

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

Возвращает

строка

Направление сортировки набора записей или 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 необязательно array()

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

Возвращает

строка|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 необязательно array()

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

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

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

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

Модель для пагинации.

Возвращает

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

Ссылка

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

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

Helper::url()

__call()source public

__call( string $method , array $params )

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

Параметры

строка $method

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

массив $params

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

__get()source public

__get( string $name )

Лениво загружает помощники. Также предоставляет доступ к устаревшим свойствам запроса.

Устарело

3.0.0 Доступ к свойствам запроса через этот метод устарел и будет удален в версии 3.0.

Параметры

строка $name

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

Возвращает

смешанный тип
Помощник или свойство, найденное в $name

__set()source public

__set( string $name , mixed $value )

Обеспечивает обратную совместимость для установки значений в объект запроса.

Устарело

3.0.0 Этот метод будет удален в версии 3.0

Параметры

строка $name

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

смешанный тип $value

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

_clean()source protected

_clean( )

Удаляет вредное содержимое из вывода.

_confirm()source protected

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

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

Параметры

строка $message

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

строка $okCode

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

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

Код, который будет выполнен после выбора пользователем «Отмена», также выполняется, когда okCode не возвращает значение

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

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

Возвращает

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

_encodeUrl()source protected

_encodeUrl( string $url )

Кодирует URL для использования в атрибутах HTML.

Параметры

строка $url

URL для кодирования.

Возвращает

строка
URL, закодированный как для URL, так и для HTML контекстов.

_formatAttribute()source protected

_formatAttribute( string $key , string $value , boolean $escape true )

Форматирует отдельный атрибут и возвращает строковое значение составленного атрибута. Работает с миниатюрными атрибутами, которые имеют то же значение, что и их имя, такие как 'disabled' и 'checked'.

Устарело

3.0.0 Этот метод будет перемещен в HtmlHelper в версии 3.0

Параметры

строка $key

Имя атрибута для создания

строка $value

Значение атрибута для создания.

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

Определяет, нужно ли экранировать значение.

Возвращает

строка
Составленный атрибут.

_initInputField()source protected

_initInputField( string $field , array $options array() )

Устанавливает значения по умолчанию для тега input. Установит атрибуты name, value и id для массива атрибутов HTML.

Параметры

строка $field

Имя поля для инициализации.

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

Массив параметров для использования при инициализации поля ввода.

Возвращает

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

_name()source protected

_name( array|string $options array() , string $field null , string $key 'name' )

Получает имя поля ввода для текущего тега. Создаёт атрибуты имени ввода, используя форматирование CakePHP data[Model][поле].

Параметры

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

Если массив, должен быть массивом атрибутов, к которому необходимо добавить $key. Если строка или null, будет использоваться как сущность представления.

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

Имя поля.

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

Имя атрибута, которое нужно установить, по умолчанию 'name'

Возвращает

смешанный тип

Если для $options был передан массив, будет возвращён массив с заданным $key. Если была передана строка, будет возвращена строка.

_parseAttributes()source protected

_parseAttributes( array $options , array $exclude null , string $insertBefore ' ' , string $insertAfter null )

Возвращает строку, разделённую пробелами, со значениями массива $options. Если ключ массива $options совпадает с одним из перечисленных в Helper::$_minimizedAttributes,

И его значение равно:

• '1' (строка)
• 1 (целое число)
• true (логическое)
• 'true' (строка)

Тогда значение будет перезаписано, чтобы быть идентичным имени ключа. Если значение не соответствует этим трём, параметр не выводится.

'escape' — специальный параметр, который управляет преобразованием атрибутов в их эквиваленты, закодированные с использованием html-сущностей. Установите в значение false, чтобы отключить кодирование html-сущностей.

Если значение для любого ключа параметра установлено в null или false, этот параметр будет исключён из вывода.

Устарело

3.0.0 Этот метод будет перенесён в HtmlHelper в версии 3.0

Параметры

массив $options

Массив опций.

массив $exclude необязательно null

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

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

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

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

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

Возвращает

строка
Составленные атрибуты.

_reset()source protected

_reset( )

Сбрасывает переменные, используемые в Helper::clean(), в значение null

_selectedArray()source protected

_selectedArray( string|array $data , string $key 'id' )

Преобразует набор записей из ассоциации hasAndBelongsToMany в список выбранных опций для элемента множественного выбора.

Параметры

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

Массив данных или имя модели.

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

Имя поля.

Возвращает

массив

addClass()source public

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

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

Параметры

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

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

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

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

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

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

Возвращает

массив
Массив опций с заданным $key.

afterLayout()source public

afterLayout( string $layoutFile )

Обработчик после макета. afterLayout вызывается после рендеринга макета.

Переопределяется в подклассах.

Параметры

строка $layoutFile

Файл макета, который был рендерен.

afterRender()source public

afterRender( string $viewFile )

Обработчик после рендера. afterRender вызывается после рендеринга файла представления, но до рендеринга макета.

Переопределяется в подклассах.

Параметры

строка $viewFile

Файл представления, который был рендерен.

afterRenderFile()source public

afterRenderFile( string $viewFile , string $content )

Обработчик после рендера файла. Вызывается после рендеринга любого фрагмента представления.

Переопределяется в подклассах.

Параметры

строка $viewFile

Файл, который только что был рендерен.

строка $content

Содержание, которое было рендеренно.

assetTimestamp()source public

assetTimestamp( string $path )

Добавляет отметку времени к файлу на основе ресурса, основанного на значении Asset.timestamp в Configure. Если Asset.timestamp имеет значение true и debug > 0, или Asset.timestamp равно 'force', будет добавлена отметка времени.

Параметры

строка $path

Путь к файлу, для которого нужно добавить отметку времени, путь должен быть внутри WWW_ROOT

Возвращает

строка
Путь с добавленной отметкой времени или без.

assetUrl()source public

assetUrl( string|array $path , array $options array() )

Генерирует URL для заданного файла ресурса. В зависимости от переданных опций предоставляет полный URL с именем домена. Также вызывает Helper::assetTimestamp() для добавления отметки времени к локальным файлам.

Параметры

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

Строка пути или массив URL

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

Массив опций. Возможные ключи: fullBase Вернуть полный URL с именем домена pathPrefix Префикс пути для относительных URL ext Расширение ресурса для добавления plugin Значение False предотвратит обработку пути как плагина

Возвращает

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

beforeLayout()source public

beforeLayout( string $layoutFile )

Обработчик перед макетом. beforeLayout вызывается перед рендерингом макета.

Переопределяется в подклассах.

Параметры

строка $layoutFile

Макет, который будет рендериться.

beforeRenderFile()source public

beforeRenderFile( string $viewFile )

Обработчик перед рендером файла. Вызывается перед рендерингом любого фрагмента представления.

Переопределяется в подклассах.

Параметры

строка $viewFile

Файл, который будет рендериться.

clean()source public

clean( string|array $output )

Используется для удаления вредных тегов из содержимого. Удаляет ряд известных атак XSS из содержимого. Однако, не гарантирует удаление всех возможных вариантов. Лучшим способом предотвращения всех возможных атак является экранирование содержимого.

Устарело

3.0.0 Этот метод будет удалён в версии 3.0

Параметры

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

Либо массив строк для очистки, либо одна строка для очистки.

Возвращает

строка|массив|null
Очищенное содержимое для вывода

domId()source public

domId( array|string $options null , string $id 'id' )

Генерирует идентификатор DOM для выбранного элемента, если он не задан. Использует текущие настройки View::entity() для генерации атрибута id с использованием регистрового стиля CamelCase.

Параметры

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

Либо массив html-атрибутов, в который нужно добавить $id, либо строка с путём к сущности представления для получения domId.

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

Имя атрибута 'id'.

Возвращает

смешанный тип

Если $options был массивом, будет возвращён массив с заданным $id. Если была передана строка, будет возвращена строка.

entity()source public

entity( )

Возвращает ссылку на сущность текущего контекста в виде массива идентификаторов.

Возвращает

array
Массив, содержащий идентификаторы элементов сущности

field()source public

field( )

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

Возвращает

string

model()source public

model( )

Получает используемую модель текущего контекста рендеринга.

Возвращает

string

output()source public

output( string $str )

Возвращает строку, сгенерированную методом помощника.

Этот метод можно переопределить в подклассах для выполнения обобщенной обработки вывода после обработки.

Устарело

3.0.0 Этот метод будет удален в будущих версиях.

Параметры

string $str

Строка, которая должна быть выведена.

Возвращает

string

setEntity()source public

setEntity( string $entity , boolean $setScope false )

Устанавливает свойства модели и поля помощника в пары значений, разделенные точкой, в $entity.

Параметры

string $entity

Имя поля, например, "ModelName.fieldName" или "ModelName.ID.fieldName"

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

Устанавливает область просмотра в модель, указанную в $tagValue

value()source public

value( array|string $options array() , string $field null , string $key 'value' )

Получает данные для текущего тега.

Параметры

array|string $options необязательно array()

Если массив, должен быть массивом атрибутов, к которым нужно добавить $key. Если строка или null, будет использоваться как сущность View.

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

Имя поля.

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

Имя атрибута, который нужно установить, по умолчанию 'value'

Возвращает

mixed

Если для $options был задан массив, возвращается массив с установленным $key. Если была передана строка, возвращается строка.

webroot()source public

webroot( string $file )

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

Параметры

string $file

Файл для создания пути webroot.

Возвращает

string
Путь к файлу, доступный через веб.

_mergeVars()source protected

_mergeVars( array $properties , string $class , boolean $normalize true )

Объединяет свойства $property этого объекта со свойствами в определении $class. Значение свойства этого класса будет объединено поверх значения $class.

Это обеспечивает некоторую DRY-магию CakePHP. Если вы хотите это отключить, переопределите этот метод как пустую функцию.

Параметры

array $properties

Имя свойств для объединения.

string $class

Класс для объединения свойства с.

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

Установить в значение true, чтобы выполнить свойства через Hash::normalize() перед объединением.

_set()source protected

_set( array $properties array() )

Позволяет установить несколько свойств объекта в одной строке кода. Будет установлены только свойства, которые являются частью объявления класса.

Параметры

array $properties необязательно array()

Ассоциативный массив, содержащий свойства и соответствующие значения.

_stop()source protected

_stop( integer|string $status 0 )

Останавливает выполнение текущего скрипта. Оборачивает exit(), что упрощает тестирование.

Параметры

integer|string $status необязательно 0

см. http://php.net/exit для значений

dispatchMethod()source public

dispatchMethod( string $method , array $params array() )

Вызывает метод этого объекта с заданными параметрами. Предоставляет ОО-обёртку для call_user_func_array

Параметры

string $method

Имя вызываемого метода

array $params необязательно array()

Список параметров, используемых при вызове $method

Возвращает

mixed
Возвращает результат вызова метода

log()source public

log( string $msg , integer $type LOG_ERR , null|string|array $scope null )

Удобный метод для записи сообщения в CakeLog. См. CakeLog::write() для получения дополнительной информации о записи в журналы.

Параметры

string $msg

Сообщение журнала

integer $type необязательно LOG_ERR

Константа типа ошибки. Определено в app/Config/core.php.

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

Области (или область), в которых создается сообщение журнала. См. CakeLog::config() для получения дополнительной информации о журналах.

Возвращает

boolean
Успешность записи в журнал

requestAction()source public

requestAction( string|array $url , array $extra array() )

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

Под капотом этот метод использует Router::reverse() для преобразования параметра $url в строковый URL. Вы должны использовать форматы URL, совместимые с Router::reverse()

Передача данных POST и GET

Данные POST и GET можно смоделировать в requestAction. Используйте $extra['url'] для данных GET. Параметр $extra['data'] позволяет смоделировать данные POST.

Параметры

string|array $url

Строковый или массивообразный URL. В отличие от других массивов URL в CakePHP, этот URL не будет автоматически обрабатывать переданные и именованные аргументы в параметре $url.

array $extra необязательно array()

если массив включает ключ "return", он устанавливает AutoRender в true. Также может использоваться для отправки данных GET/POST и именованных/переданных аргументов.

Возвращает

mixed

Логическое значение true или false при успехе/неудаче, или содержимое отрисованного действия, если 'return' установлен в $extra.

toString()source public

toString( )

Преобразование объекта в строку. Каждый класс может переопределить этот метод по мере необходимости.

Возвращает

string
Имя этого класса

'Js'

array('Html')

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