Класс HtmlHelper

__constructsource public

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

Конструктор

Настройки

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

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

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

Параметры

View $View

Представление, к которому прикреплен этот helper.

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

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

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

Helper::__construct()

_nestedListItemsource protected

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

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

Параметры

массив $items

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

массив $options

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

массив $itemOptions

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

строка $tag

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

Возвращает

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

См.

HtmlHelper::nestedList()

_prepareCrumbssource protected

_prepareCrumbs( string $startText , boolean $escape true )

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

Параметры

строка $startText

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

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

Нужно ли экранировать вывод

Возвращает

array
Список сухарей, включая startText (если задан)

addCrumbsource public

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

Добавляет ссылку в массив breadcrumbs.

Параметры

строка $name

Текст для ссылки

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

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

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

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

Возвращает

self
self

См.

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

Ссылка

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

charsetsource public

charset( string $charset null )

Возвращает тег META для кодировки символов.

Параметры

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

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

Возвращает

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

Ссылка

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

csssource 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', stylesheet будет импортирован.
• fullBase Если true, URL получит полный адрес для CSS-файла.

Параметры

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

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

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

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

Возвращает

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

Ссылка

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

divsource public

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

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

Опции

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

Параметры

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

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

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

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

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

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

Возвращает

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

Ссылка

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

docTypesource public

docType( string $type 'html5' )

Возвращает строку doctype.

Возможные doctype:
- html4-strict: HTML4 Strict. - html4-trans: HTML4 Transitional. - html4-frame: HTML4 Frameset. - html5: HTML5. Значение по умолчанию. - xhtml-strict: XHTML1 Strict. - xhtml-trans: XHTML1 Transitional. - xhtml-frame: XHTML1 Frameset. - xhtml11: XHTML1.1.

Параметры

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

Используемый doctype.

Возвращает

string|null
Строка doctype

Ссылка

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

getCrumbListsource public

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

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

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

Опции

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

Параметры

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

Массив атрибутов html, которые нужно применить к сгенерированным элементам списка.

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

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

Возвращает

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

Ссылка

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

getCrumbssource public

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

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

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

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

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

Параметры

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

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

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

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

Возвращает

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

Ссылка

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

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

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

Возвращает

string
завершенный тег img

Ссылка

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

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

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

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

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

Возвращает

string
Элемент <a>

Ссылка

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

loadConfigsource public

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

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

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

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

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

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

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

$this->Html->loadConfig(array('tags.ini', 'ini'));

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

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

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

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

Параметры

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

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

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

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

Возвращает

mixed
False в случае ошибки или загруженные конфигурации

Выбрасывает

ConfigureException
ConfigureException

Ссылка

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

mediasource 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 Тип элемента мультимедиа для генерации, "аудио" или "видео". Если тег не предоставлен, он определяется на основе MIME-типа файла.
• text Текст для включения внутри тега аудио/видео
• pathPrefix Префикс пути для использования для относительных URL-адресов, по умолчанию 'files/'
• fullBase Если предоставлен, атрибут src получит полный адрес, включая доменное имя

Параметры

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

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

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

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

Возвращает

string
Сгенерированный элемент мультимедиа

metasource public

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

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

Создайте мета-тег, который будет выводиться inline:

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

Добавьте мета-тег к $scripts_for_layout:

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

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

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

Параметры

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

Параметры

строка $type

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

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

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

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

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

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

string
Полностью сформированный <link /> элемент.

Ссылка

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

nestedListsource public

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

Создаёт вложенный список (UL/OL) из ассоциативного массива.

Параметры

массив $list

Элементы для списка

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

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

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

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

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

Тип тега списка (ol/ul)

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

string
Вложенный список

Ссылка

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

parasource public

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

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

Параметры

• escape Выводить ли содержимое с html_entity_encode.

Параметры

строка $class

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

строка $text

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

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

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

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

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

Ссылка

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

scriptsource 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 Выводить скрипт inline или в $scripts_for_layout. Установив значение false, тег скрипта будет добавлен в блок 'script' представления, а также в $scripts_for_layout.
• block Имя блока, в который нужно добавить скрипт. Оставьте undefined, чтобы вывести inline. Использование этого параметра переопределит параметр inline.
• once Проверять уникальность скрипта. Если true, скрипты будут включаться только один раз; если false, скрипт может быть включён несколько раз за один запрос.
• plugin Значение false предотвращает обработку пути как плагина.
• fullBase Если true, URL получит полный адрес файла скрипта.

Параметры

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

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

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

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

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

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

Ссылка

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

scriptBlocksource public

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

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

Параметры

• safe (boolean) Включать ли CDATA в блок скрипта.
• inline (boolean) Добавлять ли $script в блок $scripts_for_layout / script или выводить inline. (Устаревшее, используйте block вместо этого).
• block Блок, в который следует добавить этот блок скрипта. По умолчанию - script.

Параметры

строка $script

Скрипт для оборачивания

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

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

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

mixed
Строка или null в зависимости от значения $options['block']

Ссылка

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

scriptEndsource public

scriptEnd( )

Завершает буферизованную секцию захвата JavaScript. Генерирует тег script inline или в $scripts_for_layout в зависимости от настроек, использованных при запуске scriptBlock.

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

mixed
В зависимости от настроек scriptStart(), либо тег script, либо null.

Ссылка

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

scriptStartsource public

scriptStart( array $options array() )

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

Параметры

• safe Добавлять ли в блок скрипта CDATA
• inline Выводить ли генерируемый тег script inline или в $scripts_for_layout

Параметры

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

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

Ссылка

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

stylesource 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

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

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

Выводить ли блок стилей в одну строку.

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

string
CSS-стили

Ссылка

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

tableCellssource 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, не являющаяся статической, так что счётчик чётных/нечётных строк будет сброшен до нуля только для этого вызова.

Возвращает

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

Ссылка

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

tableHeaderssource public

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

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

Параметры

массив $names

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

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

HTML параметры для элементов TR.

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

HTML параметры для элементов TH.

Возвращает

string
Заголовки таблицы

Ссылка

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

tagsource public

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

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

Параметры

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

Параметры

строка $name

Имя тега.

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

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

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

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

Возвращает

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

Ссылка

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

useTagsource public

useTag( string $tag )

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

Параметры

строка $tag

Имя тега

Возвращает

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

Ссылка

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

__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

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

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

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

'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 Ложное значение предотвратит обработку пути как плагина

Возвращает

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

beforeLayoutsource public

beforeLayout( string $layoutFile )

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

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

Параметры

строка $layoutFile

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

beforeRendersource public

beforeRender( string $viewFile )

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

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

Параметры

строка $viewFile

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

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

Генерирует идентификатор DOM для выбранного элемента, если он не задан. Использует текущие настройки View::entity() для генерации идентификатора атрибута в формате 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

Имя поля, например "ИмяМодели.ИмяПоля" или "ИмяМодели.ID.ИмяПоля"

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

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

urlsource public

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

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

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

Параметры

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

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

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

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

Возвращает

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

Ссылка

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

valuesource public

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

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

Параметры

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

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

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

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

Параметры

массив $properties

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

строка $class

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

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

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

_setsource protected

_set( array $properties array() )

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

Параметры

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

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

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

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

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

Возвращает

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

toStringsource public

toString( )

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

Возвращает

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

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>',
    '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>'
)

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

array()

null

null

array()

array()

null