Класс PaginatorHelper

__constructsource 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

объект view, к которому прикреплён helper.

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

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

Исключения

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

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

Helper::__construct()

_convertUrlKeyssource protected

_convertUrlKeys( array $url , string $type )

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

Параметры

массив $url

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

строка $type

Тип ключей.

Возвращает

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

_hasPagesource protected

_hasPage( string $model , integer $page )

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

Параметры

строка $model

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

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

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

Возвращает

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

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

Опции для отключённой ссылки.

Возвращает

string
строка

beforeRendersource public

beforeRender( string $viewFile )

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

Параметры

строка $viewFile

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

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

Helper::beforeRender()

countersource 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 для списка ключей.

Возвращает

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

Ссылка

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

currentsource public

current( string $model null )

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

Параметры

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

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

Возвращает

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

Ссылка

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

defaultModelsource public

defaultModel( )

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

Возвращает

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

Ссылка

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

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

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

Возвращает

string
Строка с числами.

Ссылка

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

hasNextsource public

hasNext( string $model null )

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

Параметры

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

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

Возвращает

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

Ссылка

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

hasPagesource 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

hasPrevsource public

hasPrev( string $model null )

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

Параметры

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

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

Возвращает

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

Ссылка

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

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

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

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

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

Возвращает

string
Строка с номерами.

Ссылка

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

linksource 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 для списка ключей.

Возвращает

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

Ссылка

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

metasource public

meta( array $options array() )

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

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

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

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

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

Параметры:

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

Параметры

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

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

Возвращает

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

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

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

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

Текст, отображаемый, когда ссылка отключена.

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

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

Возвращает

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

Ссылка

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

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

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

Возвращает

string
Строка с номерами.

Ссылка

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

optionssource public

options( array|string $options array() )

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

Параметры

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

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

Ссылка

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

paramsource public

param( string $key , string $model null )

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

Параметры

строка $key

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

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

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

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

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

Ссылка

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

paramssource public

params( string $model null )

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

Параметры

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

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

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

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

Ссылка

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

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

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

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

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

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

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

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

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

Ссылка

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

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

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

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

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

Ссылка

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

sortDirsource public

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

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

Параметры

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

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

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

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

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

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

Ссылка

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

sortKeysource public

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

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

Параметры

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

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

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

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

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

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

Ссылка

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

urlsource public

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

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

Параметры

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

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

логическое $asArray необязательно false

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

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

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

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

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

Переопределения

Helper::url()

__callsource public

__call( string $method , array $params )

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

Параметры

строка $method

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

массив $params

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

__getsource public

__get( string $name )

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

Устарело

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

Параметры

строка $name

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

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

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

__setsource public

__set( string $name , mixed $value )

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

Устарело

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

Параметры

строка $name

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

смешанное $value

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

_cleansource protected

_clean( )

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

_confirmsource protected

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

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

Параметры

строка $message

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

строка $okCode

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

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

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

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

Массив опций

Возвращает

string
JS-код onclick

_encodeUrlsource protected

_encodeUrl( string $url )

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

Параметры

строка $url

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

Возвращает

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

_formatAttributesource protected

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

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

Устаревшее

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

Параметры

строка $key

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

строка $value

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

логическое значение $escape необязательно true

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

Возвращает

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

_initInputFieldsource protected

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

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

Параметры

строка $field

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

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

Массив опций, используемых при инициализации поля ввода.

Возвращает

array
Массив опций для поля формы.

_namesource protected

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

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

Параметры

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

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

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

Имя поля.

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

Имя атрибута для установки, по умолчанию «name»

Возвращает

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

_parseAttributessource 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

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

Возвращает

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

_resetsource protected

_reset( )

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

_selectedArraysource protected

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

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

Параметры

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

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

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

Имя поля.

Возвращает

array
массив

addClasssource public

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

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

Параметры

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

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

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

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

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

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

Возвращает

array
Массив опций со значением $key.

afterLayoutsource public

afterLayout( string $layoutFile )

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

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

Параметры

строка $layoutFile

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

afterRendersource public

afterRender( string $viewFile )

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

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

Параметры

строка $viewFile

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

afterRenderFilesource public

afterRenderFile( string $viewFile , string $content )

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

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

Параметры

строка $viewFile

Файл, который только что был отрисован.

строка $content

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

assetTimestampsource public

assetTimestamp( string $path )

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

Параметры

строка $path

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

Возвращает

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

assetUrlsource public

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

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

Параметры

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

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

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

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

Возвращает

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

beforeLayoutsource public

beforeLayout( string $layoutFile )

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

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

Параметры

строка $layoutFile

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

beforeRenderFilesource public

beforeRenderFile( string $viewFile )

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

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

Параметры

строка $viewFile

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

cleansource public

clean( string|array $output )

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

Устаревший

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

Параметры

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

Массив строк для очистки или одна строка для очистки.

Возвращает

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

domIdsource public

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

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

Параметры

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

Массив HTML-атрибутов для добавления $id или строка с путем к сущности представления для получения domId.

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

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

Возвращает

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

entitysource public

entity( )

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

Возвращает

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

fieldsource public

field( )

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

Возвращает

string
строка

modelsource public

model( )

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

Возвращает

string
строка

outputsource public

output( string $str )

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

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

Устаревший

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

Параметры

строка $str

Строка, которая будет выведена.

Возвращает

string
строка

setEntitysource public

setEntity( string $entity , boolean $setScope false )

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

Параметры

строка $entity

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

логическое значение $setScope необязательно false

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

valuesource public

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

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

Параметры

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

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

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

Имя поля.

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

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

Возвращает

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

webrootsource public

webroot( string $file )

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

Параметры

строка $file

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

Возвращает

string
Веб-доступный путь к файлу.

_mergeVarssource protected

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

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

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

Параметры

массив $properties

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

строка $class

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

логическое значение $normalize необязательно true

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

_setsource protected

_set( array $properties array() )

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

Параметры

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

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

_stopsource protected

_stop( integer|string $status 0 )

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

Параметры

целое число или строка $status необязательно 0

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

dispatchMethodsource public

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

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

Параметры

строка $method

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

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

Список параметров для использования при вызове $method

Возвращает

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

logsource public

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

Метод-обёртка для записи сообщения в CakeLog. Для получения более подробной информации о записи в журналы, см. CakeLog::write().

Параметры

строка $msg

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

целое число $type необязательно LOG_ERR

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

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

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

Возвращает

boolean
Успех записи в журнал

requestActionsource 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.

Параметры

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

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

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

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

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

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

toStringsource public

toString( )

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

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

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

'Js'

array('Html')

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

'%s="%s"'

null

array(
    'year', 'month', 'day', 'hour', 'min', 'second', 'meridian'
)

array()

'%s="%s"'

array(
    'allowfullscreen',
    'async',
    'autofocus',
    'autoplay',
    'checked',
    'compact',
    'controls',
    'declare',
    'default',
    'defaultchecked',
    'defaultmuted',
    'defaultselected',
    'defer',
    'disabled',
    'enabled',
    'formnovalidate',
    'hidden',
    'indeterminate',
    'inert',
    'ismap',
    'itemscope',
    'loop',
    'multiple',
    'muted',
    'nohref',
    'noresize',
    'noshade',
    'novalidate',
    'nowrap',
    'open',
    'pauseonexit',
    'readonly',
    'required',
    'reversed',
    'scoped',
    'seamless',
    'selected',
    'sortable',
    'spellcheck',
    'truespeed',
    'typemustmatch',
    'visible'
)

null

array()

null

null

array()

array()

null