Класс HtmlHelper

__construct()источник public

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

Конструктор

Настройки

• configFile Файл, содержащий массив тегов, которые вы хотите переопределить.

Настройка наборов тегов

Используя параметр configFile, вы можете переопределить тег, который будет использовать HtmlHelper. Файл должен быть совместим с HtmlHelper::loadConfig().

Параметры

View $View

View, к которому подключается этот helper.

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

Настройки конфигурации helper.

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

Helper::__construct()

_nestedListItem()источник protected

_nestedListItem( array $items , array $options , array $itemOptions , string $tag )

Внутренняя функция для создания вложенного списка (UL/OL) из ассоциативного массива.

Параметры

массив $items

Набор элементов для списка

массив $options

Дополнительные атрибуты HTML тега списка (ol/ul)

массив $itemOptions

Дополнительные атрибуты HTML тега элемента списка (LI)

строка $tag

Тип тега списка, который нужно использовать (ol/ul)

Возвращает

строка
Элемент вложенного списка

См. также

HtmlHelper::nestedList()

_prepareCrumbs()источник protected

_prepareCrumbs( string $startText , boolean $escape true )

Добавляет startText в массив breadcrumbs, если он задан

Параметры

строка $startText

Текст для добавления

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

Если вывод должен быть экранирован или нет

Возвращает

массив
Список хлебных крошек, включая startText (если предоставлен)

addCrumb()источник public

addCrumb( string $name , string $link null , string|array $options null )

Добавляет ссылку в массив хлебных крошек.

Параметры

строка $name

Текст ссылки

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

URL ссылки (если пусто, это не будет ссылка)

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

Атрибуты ссылки, например array('id' => 'selected')

Возвращает

HtmlHelper

См. также

HtmlHelper::link() для деталей $options, которые могут быть использованы.

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/html.html#создание-хлебных-крошек-с-htmlhelper

charset()source public

charset( string $charset null )

Возвращает тег META charset.

Параметры

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

Кодировка символов, используемая в теге meta. Если пусто, используется значение App.encoding. Пример: "utf-8".

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

строка
Тег meta, содержащий указанную кодировку символов.

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/html.html#HtmlHelper::charset

css()source public

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

Создаёт элемент ссылки для CSS-стилей.

Использование

Включение одного файла CSS:

echo $this->Html->css('styles.css');

Включение нескольких файлов CSS:

echo $this->Html->css(array('one.css', 'two.css'));

Добавление стиля в переменную макета $scripts_for_layout:

$this->Html->css('styles.css', array('inline' => false));

Добавление стиля в пользовательский блок:

$this->Html->css('styles.css', array('block' => 'layoutCss'));

Опции

• inline Если установлено в false, сгенерированный тег будет добавлен в блок 'css', и включён в переменную макета $scripts_for_layout. По умолчанию true.
• once Проверять ли уникальность файла css. Если true, файлы css будут включены только один раз. Установите false, чтобы разрешить включение одного и того же css более одного раза за запрос.
• block Установить имя блока, к которому будет добавлен тег ссылки/стиля. Это переопределяет опцию inline.
• plugin Значение false предотвратит обработку пути как плагина
• rel По умолчанию 'stylesheet'. Если равно 'import', стиль будет импортирован.
• fullBase Если true, URL получит полный адрес для файла css.

Параметры

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

Имя файла CSS-стиля или массив, содержащий имена файлов CSS-стилей. Если $path начинается с '/', путь будет относительным к корню webroot вашего приложения. В противном случае путь будет относительным к вашему пути CSS, обычно webroot/css.

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

Массив опций и HTML-аргументов.

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

строка
CSS <link /> или <style /> тег, в зависимости от типа ссылки.

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/html.html#HtmlHelper::css

div()source public

div( string $class null , string $text null , array $options array() )

Возвращает отформатированный тег DIV для HTML-форм.

Опции

• escape Будут ли содержимое html_entity escaped.

Параметры

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

Имя класса CSS для элемента div.

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

Строковое содержимое, которое будет отображаться внутри элемента div. Если null, будет напечатан только открывающий тег.

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

Дополнительные HTML-атрибуты тега DIV.

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

строка
Отформатированный элемент DIV

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/html.html#HtmlHelper::div

docType()source public

docType( string $type 'html5' )

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

Возможные типы документов:

• html4-strict: HTML4 Строгий.
• html4-trans: HTML4 Переходный.
• html4-frame: HTML4 Фреймы.
• html5: HTML5. Значение по умолчанию.
• xhtml-strict: XHTML1 Строгий.
• xhtml-trans: XHTML1 Переходный.
• xhtml-frame: XHTML1 Фреймы.
• xhtml11: XHTML1.1.

Параметры

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

Тип документа для использования.

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

строка|null
Строка типа документа

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/html.html#HtmlHelper::docType

getCrumbList()source public

getCrumbList( array $options array() , string|array|boolean $startText false )

Возвращает хлебные крошки в виде списка (x)html.

Этот метод использует HtmlHelper::tag() для генерации списка и его элементов. Работает аналогично HtmlHelper::getCrumbs(), поэтому использует опции, которые были добавлены для каждой крошки.

Опции

• separator Содержимое разделителя для вставки между хлебными крошками, по умолчанию ''
• firstClass Класс для обертывающего тега первой хлебной крошки, по умолчанию 'first'
• lastClass Класс для обертывающего тега текущей активной страницы, по умолчанию 'last'

Параметры

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

Массив HTML-атрибутов, применяемых к сгенерированным элементам списка.

строка|массив|логическое $startText необязательно false

Это будет первая крошка, если false, она по умолчанию первая в массиве. Также может быть массивом, см. HtmlHelper::getCrumbs для подробностей.

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

строка|null
Список хлебных крошек html

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/html.html#creating-breadcrumb-trails-with-htmlhelper

getCrumbs()source public

getCrumbs( string $separator '»' , string|array|boolean $startText false )

Возвращает след хлебных крошек как последовательность с разделителями ».

Если $startText является массивом, допустимые ключи:

• text Определите текст/содержимое для ссылки.
• url Определите целевой адрес созданной ссылки.

Все остальные ключи будут переданы в HtmlHelper::link() в качестве параметра $options.

Параметры

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

Текст для разделения крошек.

строка|массив|логическое $startText необязательно false

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

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

строка|null
Составленные хлебные крошки

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/html.html#creating-breadcrumb-trails-with-htmlhelper

image()source public

image( string $path , array $options array() )

Создаёт отформатированный элемент IMG.

Этот метод установит пустой атрибут alt, если он не задан.

Использование:

Создание обычной картинки:

echo $this->Html->image('cake_icon.png', array('alt' => 'CakePHP'));

Создание ссылки на картинку:

echo $this->Html->image('cake_icon.png', array('alt' => 'CakePHP', 'url' => 'http://cakephp.org'));

Опции:

• url Если задано, будет сгенерирована ссылка на картинку, и ссылка будет указывать на $options['url'].
• fullBase Если true, атрибут src получит полный адрес для файла изображения.
• plugin Значение false предотвратит обработку пути как плагина

Параметры

строка $path

Путь к файлу изображения, относительно каталога app/webroot/img/.

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

Массив HTML-атрибутов. См. выше для специальных опций.

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

строка
Законченный тег img

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/html.html#HtmlHelper::image

link()source public

link( string $title , string|array $url null , array $options array() , string $confirmMessage false )

Создаёт HTML-ссылку.

Если $url начинается с "http://", это рассматривается как внешняя ссылка. В противном случае, она обрабатывается как путь к контроллеру/действию и анализируется с помощью метода HtmlHelper::url().

Если $url пустое, используется $title вместо него.

Параметры

• escape Установите в false, чтобы отключить экранирование заголовка и атрибутов.
• escapeTitle Установите в false, чтобы отключить экранирование заголовка. (Имеет приоритет над значением escape)
• confirm Сообщение подтверждения JavaScript.

Параметры

строка $title

Содержимое, которое будет заключено в <a> теги.

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

Относительный к Cake URL или массив параметров URL, или внешний URL (начинается с http://)

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

Массив опций и HTML-атрибутов.

строка $confirmMessage необязательно false

Сообщение подтверждения JavaScript. Этот аргумент устарел начиная с версии 2.6. Используйте ключ confirm в $options вместо него.

Возвращает

строка
Элемент <a />.

Ссылка

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

loadConfig()source public

loadConfig( string|array $configFile , string $path null )

Загрузить конфигурацию тегов HTML.

Загружает файл из APP/Config, содержащий данные тегов. По умолчанию ожидается, что файл совместим с PhpReader:

$this->Html->loadConfig('tags.php');

tags.php может выглядеть так:

$tags = array(
    'meta' => '<meta%s>'
);

Если вы хотите хранить определения тегов в другом формате, вы можете передать массив, содержащий имя файла и имя класса ридера:

tags

Ожидается, что индекс tags будет существовать во всех считанных конфигурационных файлах. Вы также можете указать путь к файлу конфигурации, если он не находится в APP/Config.

$this->Html->loadConfig('tags.php', APP . 'Lib' . DS);

Файлы конфигурации могут определять следующие разделы:

• tags Теги для замены.
• minimizedAttributes Атрибуты, представленные как disabled="disabled"
• docTypes Дополнительные типы документов.
• attributeFormat Формат для длинных атрибутов, например, '%s="%s"'
• minimizedAttributeFormat Формат для миниатюрных атрибутов, например, '%s="%s"'

Параметры

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

Строка с конфигурационным файлом (загрузить с помощью PhpReader) или массив с именем файла и ридера.

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

Путь к конфигурационному файлу.

Возвращает

смешанный тип
False при ошибке или загруженные конфигурации

Выбрасывает

ConfigureException

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/html.html#changing-the-tags-output-by-htmlhelper

media()source public

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

Возвращает аудио/видео элемент.

Использование

Использование аудио файла:

echo $this->Html->media('audio.mp3', array('fullBase' => true));

Вывод:

<video src="http://www.somehost.com/files/audio.mp3">Fallback text</video>

Использование видео файла:

echo $this->Html->media('video.mp4', array('text' => 'Fallback text'));

Вывод:

<video src="/files/video.mp4">Fallback text</video>

Использование нескольких видео файлов:

echo $this->Html->media(
        array('video.mp4', array('src' => 'video.ogv', 'type' => "video/ogg; codecs='theora, vorbis'")),
        array('tag' => 'video', 'autoplay')
);

Вывод:

<video autoplay="autoplay">
        <source src="/files/video.mp4" type="video/mp4"/>
        <source src="/files/video.ogv" type="video/ogv; codecs='theora, vorbis'"/>
</video>

Параметры

• tag Тип элемента медиа, который нужно сгенерировать, "audio" или "video". Если тег не указан, он определяется по типу MIME файла.
• text Текст, который нужно включить внутри тега аудио/видео.
• pathPrefix Префикс пути для использования относительных URL, по умолчанию 'files/'
• fullBase Если указано, атрибут src получит полный адрес, включая доменное имя

Параметры

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

Путь к видео файлу, относительно каталога webroot/{$options['pathPrefix']}. Или массив, где каждый элемент сам может быть строкой пути или ассоциативным массивом, содержащим ключи src и type

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

Массив HTML-атрибутов и специальных опций выше.

Возвращает

строка
Сгенерированный медиа элемент

meta()source public

meta( string $type , string|array $url null , array $options array() )

Создаёт ссылку на внешний ресурс и обрабатывает базовые теги meta

Создайте тег meta, который выводится непосредственно:

`$this->Html->meta('icon', 'favicon.ico');

Добавьте тег meta в $scripts_for_layout:

$this->Html->meta('description', 'A great page', array('inline' => false));

Добавьте тег meta в пользовательский блок представления:

$this->Html->meta('description', 'A great page', array('block' => 'metaTags'));

Параметры

• inline Выводить ли элемент ссылки непосредственно. Установите в false, чтобы тег meta был включён в $scripts_for_layout и добавлен в блок представления 'meta'.
• block Выбрать пользовательский блок для добавления тега meta. Использование этой опции переопределит опцию inline.

Параметры

строка $type

Название внешнего ресурса

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

Адрес внешнего ресурса или строка для атрибута content

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

Другие атрибуты для сгенерированного тега. Если атрибут type — html, rss, atom или icon, возвращается тип MIME.

Возвращает

строка
Завершенный элемент <link />.

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/html.html#HtmlHelper::meta

nestedList()source public

nestedList( array $list , array $options array() , array $itemOptions array() , string $tag 'ul' )

Создать список (UL/OL) из ассоциативного массива.

Параметры

массив $list

Набор элементов для списка

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

Дополнительные HTML-атрибуты тега списка (ol/ul), или, если ul/ol используются как тег

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

Дополнительные HTML-атрибуты тега элемента списка (LI)

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

Тип тега списка для использования (ol/ul)

Возвращает

строка
Список

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/html.html#HtmlHelper::nestedList

para()source public

para( string $class , string $text , array $options array() )

Возвращает отформатированный тег P.

Параметры

• escape Нужно ли экранировать содержимое с помощью html_entity.

Параметры

строка $class

Имя класса CSS для элемента p.

строка $text

Строковое содержимое, которое будет отображаться внутри элемента p.

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

Дополнительные HTML-атрибуты тега P.

Возвращает

строка
Отформатированный элемент P

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/html.html#HtmlHelper::para

script()source public

script( string|array $url , array|boolean $options array() )

Возвращает один или несколько тегов <script>, в зависимости от количества переданных скриптов.

Если имя файла начинается с "/", путь будет относительным к корневому пути вашего приложения. В противном случае, путь будет относительным к пути к JavaScript, обычно webroot/js.

Использование

Включение одного файла скрипта:

echo $this->Html->script('styles.js');

Включение нескольких файлов скриптов:

echo $this->Html->script(array('one.js', 'two.js'));

Добавление файла скрипта в переменную макета $scripts_for_layout:

$this->Html->script('styles.js', array('inline' => false));

Добавление файла скрипта в пользовательский блок:

$this->Html->script('styles.js', array('block' => 'bodyScript'));

Параметры

• inline Флаг, определяющий, должен ли скрипт выводиться встраиваемо или в блок $scripts_for_layout. Если false, тег <script> будет добавлен в блок 'script' представления, а также в $scripts_for_layout.
• block Имя блока, в который должен быть добавлен скрипт. Оставьте неопределённым для встраиваемого вывода. Использование этого параметра переопределит параметр inline.
• once Флаг, указывающий, нужно ли проверять уникальность скрипта. Если true, скрипт будет включён только один раз; используйте false, чтобы разрешить включение одного и того же скрипта более чем один раз за запрос.
• plugin Значение false предотвратит обработку пути как плагина
• fullBase Если true, URL получит полный адрес для файла скрипта.

Параметры

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

Строка или массив файлов JavaScript для включения

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

Массив параметров и HTML-атрибутов, см. выше. Если булево, устанавливает $options['inline'] = значение

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

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

Строка тегов <script> или null, если $inline равен false или если $once равен true, и файл уже был включён ранее.

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/html.html#HtmlHelper::script

scriptBlock()source public

scriptBlock( string $script , array $options array() )

Оборачивает $script в тег <script>.

Параметры

• safe (булево) Флаг, указывающий, нужно ли оборачивать $script в <![CDATA[ ]]>
• inline (булево) Флаг, указывающий, нужно ли добавлять $script в блок $scripts_for_layout / script, или выводить встраиваемо. (Устарело, используйте block вместо)
• block Блок, в который должен быть добавлен этот блок скрипта. По умолчанию script.

Параметры

строка $script

Скрипт для обёртки

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

Параметры для использования. Неперечисленные параметры будут обработаны как HTML-атрибуты.

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

смешанный тип
строка или null, в зависимости от значения $options['block']

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/html.html#HtmlHelper::scriptBlock

scriptEnd()source public

scriptEnd( )

Завершает буферизованный раздел захвата JavaScript. Создаёт тег <script> встраиваемо или в $scripts_for_layout в зависимости от настроек, установленных при вызове scriptBlock()

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

смешанный тип
в зависимости от настроек scriptStart(), либо тег <script>, либо null

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/html.html#HtmlHelper::scriptEnd

scriptStart()source public

scriptStart( array $options array() )

Начинает блок скрипта, который захватывает вывод до тех пор, пока не будет вызван HtmlHelper::scriptEnd(). Этот блок захвата будет захватывать весь вывод между методами и создавать из него scriptBlock.

Параметры

• safe Флаг, определяющий, должен ли блок кода содержать CDATA
• inline Тег <script> должен выводиться встраиваемо или в $scripts_for_layout

Параметры

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

Параметры для блока кода.

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/html.html#HtmlHelper::scriptStart

style()source public

style( array $data , boolean $oneline true )

Создаёт данные CSS из массива свойств CSS.

Использование:

echo $this->Html->style(array('margin' => '10px', 'padding' => '10px'), true);

// creates
'margin:10px;padding:10px;'

Параметры

массив $data

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

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

Указывает, должен ли блок стиля отображаться в одну строку.

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

строка
Данные CSS-стилей

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/html.html#HtmlHelper::style

tableCells()source public

tableCells( array $data , array $oddTrOptions null , array $evenTrOptions null , boolean $useCount false , boolean $continueOddEven true )

Возвращает отформатированную строку строк таблицы (<tr> с <td> в них).

Параметры

массив $data

Массив данных таблицы

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

HTML-параметры для нечётных элементов <tr>, если true используется useCount

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

HTML-параметры для чётных элементов <tr>

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

Добавляет класс "column-$i"

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

Если false, будет использоваться динамическая переменная $count, поэтому счётчик чётных/нечётных элементов будет сброшен до нуля только для этого вызова.

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

строка
Отформатированный HTML

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/html.html#HtmlHelper::tableCells

tableHeaders()source public

tableHeaders( array $names , array $trOptions null , array $thOptions null )

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

Параметры

массив $names

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

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

HTML-параметры для элементов <tr>.

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

HTML-параметры для элементов <th>.

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

строка
Заголовки завершённой таблицы

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/html.html#HtmlHelper::tableHeaders

tag()source public

tag( string $name , string $text null , array $options array() )

Возвращает отформатированный блочный тег, например, DIV, SPAN, P.

Параметры

• escape Флаг, указывающий, следует ли кодировать содержимое в HTML-сущности.

Параметры

строка $name

Имя тега.

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

Строковое содержимое, которое будет отображаться внутри элемента div. Если null, будет выведен только стартовый тег.

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

Дополнительные HTML-атрибуты тега DIV, см. выше.

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

строка
Отформатированный элемент тега

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/html.html#HtmlHelper::tag

useTag()source public

useTag( string $tag )

Возвращает отформатированный существующий блок $tags.

Параметры

строка $tag

Имя тега

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

строка
Отформатированный блок

Ссылка

http://book.cakephp.org/2.0/ru/core-libraries/helpers/html.html#HtmlHelper::useTag

__call()source public

__call( string $method , array $params )

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

Параметры

string $method

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

array $params

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

__get()source public

__get( string $name )

Ленично загружает хелперы. Также обеспечивает доступ к устаревшим свойствам запроса.

Устарело

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

Параметры

string $name

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

Возвращает

mixed
Хелпер или свойство, найденное по $name

__set()source public

__set( string $name , mixed $value )

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

Устарело

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

Параметры

string $name

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

mixed $value

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

_clean()source protected

_clean( )

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

_confirm()source protected

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

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

Параметры

string $message

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

string $okCode

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

string $cancelCode optional ''

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

array $options optional array()

Массив опций

Возвращает

string
Код JS для onclick

_encodeUrl()source protected

_encodeUrl( string $url )

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

Параметры

string $url

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

Возвращает

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

_formatAttribute()source protected

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

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

Устарело

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

Параметры

string $key

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

string $value

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

boolean $escape optional true

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

Возвращает

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

_initInputField()source protected

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

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

Параметры

string $field

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

array $options optional array()

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

Возвращает

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

_name()source protected

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

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

Параметры

array|string $options optional array()

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

string $field optional null

Имя поля.

string $key optional 'name'

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

Возвращает

mixed

Если для $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

Параметры

array $options

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

array $exclude optional null

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

string $insertBefore optional ' '

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

string $insertAfter optional null

Строка, вставляемая после опций.

Возвращает

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

_reset()source protected

_reset( )

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

_selectedArray()source protected

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

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

Параметры

string|array $data

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

string $key optional 'id'

Имя поля.

Возвращает

array

addClass()source public

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

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

Параметры

array $options optional array()

Массив опций/атрибутов для добавления класса

string $class optional null

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

string $key optional 'class'

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

Возвращает

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

afterLayout()source public

afterLayout( string $layoutFile )

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

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

Параметры

string $layoutFile

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

afterRender()source public

afterRender( string $viewFile )

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

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

Параметры

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

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

Возвращает

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

beforeLayout()source public

beforeLayout( string $layoutFile )

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

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

Параметры

строка $layoutFile

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

beforeRender()source public

beforeRender( string $viewFile )

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

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

Параметры

строка $viewFile

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

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() для генерации идентификатора атрибута CamelCased.

Параметры

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

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

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

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

Возвращает

смешанное

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

entity()source public

entity( )

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

Возвращает

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

field()source public

field( )

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

Возвращает

строка

model()source public

model( )

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

Возвращает

строка

output()source public

output( string $str )

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

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

Устарело

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

Параметры

строка $str

Строка для вывода.

Возвращает

строка

setEntity()source public

setEntity( string $entity , boolean $setScope false )

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

Параметры

строка $entity

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

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

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

url()source public

url( string|array $url null , boolean $full false )

Находит URL для указанного действия.

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

Параметры

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

Относительный URL-адрес, например, /products/view/23, или массив параметров URL. Использование массива для URL позволит использовать возможности обратной маршрутизации CakePHP.

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

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

Возвращает

строка
Полный переведенный URL с базовым путем.

Ссылка

http://book.cakephp.org/2.0/ru/views/helpers.html

value()source public

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

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

Параметры

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

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

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

Имя поля.

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

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

Возвращает

смешанное

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

webroot()source public

webroot( string $file )

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

Параметры

строка $file

Файл, для которого нужно создать путь webroot.

Возвращает

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

_mergeVars()source protected

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

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

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

Параметры

массив $properties

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

строка $class

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

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

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

_set()source protected

_set( array $properties array() )

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

Параметры

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

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

_stop()source protected

_stop( integer|string $status 0 )

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

Параметры

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

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

dispatchMethod()source public

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

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

Параметры

строка $method

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

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

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

Возвращает

mixed
Результат вызова метода

log()source 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
Результат записи в лог

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.

Параметры

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

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

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

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

Возвращает

mixed

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

toString()source public

toString( )

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

Возвращает

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

array()

array(
    'html4-strict' => '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">',
    'html4-trans' => '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">',
    'html4-frame' => '<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd">',
    'html5' => '<!DOCTYPE html>',
    'xhtml-strict' => '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">',
    'xhtml-trans' => '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">',
    'xhtml-frame' => '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">',
    'xhtml11' => '<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">'
)

array()

array()

array(
    'meta' => '<meta%s/>',
    'metalink' => '<link href="%s"%s/>',
    'link' => '<a href="%s"%s>%s</a>',
    'mailto' => '<a href="mailto:%s"%s>%s</a>',
    'form' => '<form action="%s"%s>',
    'formwithoutaction' => '<form%s>',
    'formend' => '</form>',
    'input' => '<input name="%s"%s/>',
    'textarea' => '<textarea name="%s"%s>%s</textarea>',
    'hidden' => '<input type="hidden" name="%s"%s/>',
    'checkbox' => '<input type="checkbox" name="%s"%s/>',
    'checkboxmultiple' => '<input type="checkbox" name="%s[]"%s />',
    'radio' => '<input type="radio" name="%s" id="%s"%s />%s',
    'selectstart' => '<select name="%s"%s>',
    'selectmultiplestart' => '<select name="%s[]"%s>',
    'selectempty' => '<option value=""%s>&nbsp;</option>',
    'selectoption' => '<option value="%s"%s>%s</option>',
    'selectend' => '</select>',
    'optiongroup' => '<optgroup label="%s"%s>',
    'optiongroupend' => '</optgroup>',
    'checkboxmultiplestart' => '',
    'checkboxmultipleend' => '',
    'password' => '<input type="password" name="%s"%s/>',
    'file' => '<input type="file" name="%s"%s/>',
    'file_no_model' => '<input type="file" name="%s"%s/>',
    'submit' => '<input%s/>',
    'submitimage' => '<input type="image" src="%s"%s/>',
    'button' => '<button%s>%s</button>',
    'image' => '<img src="%s"%s/>',
    'tableheader' => '<th%s>%s</th>',
    'tableheaderrow' => '<tr%s>%s</tr>',
    'tablecell' => '<td%s>%s</td>',
    'tablerow' => '<tr%s>%s</tr>',
    'block' => '<div%s>%s</div>',
    'blockstart' => '<div%s>',
    'blockend' => '</div>',
    'hiddenblock' => '<div style="display:none;">%s</div>',
    'tag' => '<%s%s>%s</%s>',
    'tagstart' => '<%s%s>',
    'tagend' => '</%s>',
    'tagselfclosing' => '<%s%s/>',
    'para' => '<p%s>%s</p>',
    'parastart' => '<p%s>',
    'label' => '<label for="%s"%s>%s</label>',
    'fieldset' => '<fieldset%s>%s</fieldset>',
    'fieldsetstart' => '<fieldset><legend>%s</legend>',
    'fieldsetend' => '</fieldset>',
    'legend' => '<legend>%s</legend>',
    'css' => '<link rel="%s" type="text/css" href="%s"%s/>',
    'style' => '<style type="text/css"%s>%s</style>',
    'charset' => '<meta http-equiv="Content-Type" content="text/html; charset=%s" />',
    'ul' => '<ul%s>%s</ul>',
    'ol' => '<ol%s>%s</ol>',
    'li' => '<li%s>%s</li>',
    'error' => '<div%s>%s</div>',
    'javascriptblock' => '<script%s>%s</script>',
    'javascriptstart' => '<script>',
    'javascriptlink' => '<script type="text/javascript" src="%s"%s></script>',
    'javascriptend' => '</script>'
)