Spec-Zone.ru › Yii 2.0

Класс yii\helpers\BaseHtml

Все классы | Свойства | Методы
Наследование yii\helpers\BaseHtml
Подклассы yii\bootstrap\BaseHtml, yii\bootstrap\Html, yii\helpers\Html
Доступно с версии 2.0
Исходный код https://github.com/yiisoft/yii2/blob/master/framework/helpers/BaseHtml.php

BaseHtml предоставляет конкретную реализацию для yii\helpers\Html.

Не используйте BaseHtml. Используйте yii\helpers\Html вместо него.

Публичные свойства

Свойство Тип Описание Определено в
$attributeOrder массив Предпочтительный порядок атрибутов в теге. yii\helpers\BaseHtml
$attributeRegex строка Регулярное выражение, используемое для проверки имени атрибута. yii\helpers\BaseHtml
$dataAttributes массив Список атрибутов тега, которые должны обрабатываться особым образом, когда их значения являются массивами. yii\helpers\BaseHtml
$voidElements массив Список пустых элементов (имя элемента => 1) yii\helpers\BaseHtml

Публичные методы

Метод Описание Определено в
a() Генерирует тег гиперссылки. yii\helpers\BaseHtml
activeCheckbox() Генерирует тег флажка вместе с меткой для указанного атрибута модели. yii\helpers\BaseHtml
activeCheckboxList() Генерирует список флажков. yii\helpers\BaseHtml
activeDropDownList() Генерирует выпадающий список для указанного атрибута модели. yii\helpers\BaseHtml
activeFileInput() Генерирует тег ввода файла для указанного атрибута модели. yii\helpers\BaseHtml
activeHiddenInput() Генерирует тег скрытого ввода для указанного атрибута модели. yii\helpers\BaseHtml
activeHint() Генерирует тег подсказки для указанного атрибута модели. yii\helpers\BaseHtml
activeInput() Генерирует тег ввода для указанного атрибута модели. yii\helpers\BaseHtml
activeLabel() Генерирует тег метки для указанного атрибута модели. yii\helpers\BaseHtml
activeListBox() Генерирует список. yii\helpers\BaseHtml
activePasswordInput() Генерирует тег ввода пароля для указанного атрибута модели. yii\helpers\BaseHtml
activeRadio() Генерирует тег радиокнопки вместе с меткой для указанного атрибута модели. yii\helpers\BaseHtml
activeRadioList() Генерирует список радиокнопок. yii\helpers\BaseHtml
activeTextInput() Генерирует тег ввода текста для указанного атрибута модели. yii\helpers\BaseHtml
activeTextarea() Генерирует тег textarea для указанного атрибута модели. yii\helpers\BaseHtml
addCssClass() Добавляет CSS-класс (или несколько классов) к указанным опциям. yii\helpers\BaseHtml
addCssStyle() Добавляет указанный CSS-стиль к HTML-опциям. yii\helpers\BaseHtml
beginForm() Генерирует открывающий тег формы. yii\helpers\BaseHtml
beginTag() Генерирует открывающий тег. yii\helpers\BaseHtml
button() Генерирует тег кнопки. yii\helpers\BaseHtml
buttonInput() Генерирует кнопку ввода. yii\helpers\BaseHtml
checkbox() Генерирует флажок ввода. yii\helpers\BaseHtml
checkboxList() Генерирует список флажков. yii\helpers\BaseHtml
csrfMetaTags() Генерирует мета-теги, содержащие информацию о токен CSRF. yii\helpers\BaseHtml
cssFile() Генерирует тег ссылки, указывающий на внешний CSS-файл. yii\helpers\BaseHtml
cssStyleFromArray() Преобразует массив CSS-стилей в строковое представление. yii\helpers\BaseHtml
cssStyleToArray() Преобразует строковое представление CSS-стилей в массив. yii\helpers\BaseHtml
decode() Декодирует специальные HTML-сущности обратно в соответствующие символы. yii\helpers\BaseHtml
dropDownList() Генерирует выпадающий список. yii\helpers\BaseHtml
encode() Кодирует специальные символы в HTML-сущности. yii\helpers\BaseHtml
endForm() Генерирует закрывающий тег формы. yii\helpers\BaseHtml
endTag() Генерирует закрывающий тег. yii\helpers\BaseHtml
error() Генерирует тег, содержащий первую ошибку валидации для указанного атрибута модели. yii\helpers\BaseHtml
errorSummary() Генерирует сводку ошибок валидации. yii\helpers\BaseHtml
escapeJsRegularExpression() Экранирует выражение регулярного выражения для использования в JavaScript yii\helpers\BaseHtml
fileInput() Генерирует поле ввода файла. yii\helpers\BaseHtml
getAttributeName() Возвращает фактическое имя атрибута из заданного выражения атрибута. yii\helpers\BaseHtml
getAttributeValue() Возвращает значение заданного имени или выражения атрибута. yii\helpers\BaseHtml
getInputId() Генерирует соответствующий идентификатор ввода для указанного имени или выражения атрибута. yii\helpers\BaseHtml
getInputName() Генерирует соответствующее имя ввода для указанного имени или выражения атрибута. yii\helpers\BaseHtml
hiddenInput() Генерирует скрытое поле ввода. yii\helpers\BaseHtml
img() Генерирует тег изображения. yii\helpers\BaseHtml
input() Генерирует элемент ввода указанного типа. yii\helpers\BaseHtml
jsFile() Генерирует тег script, указывающий на внешний JavaScript-файл. yii\helpers\BaseHtml
label() Генерирует тег метки. yii\helpers\BaseHtml
listBox() Генерирует список. yii\helpers\BaseHtml
mailto() Генерирует гиперссылку mailto. yii\helpers\BaseHtml
ol() Генерирует нумерованный список. yii\helpers\BaseHtml
passwordInput() Генерирует поле ввода пароля. yii\helpers\BaseHtml
radio() Генерирует элемент радиокнопки ввода. yii\helpers\BaseHtml
radioList() Генерирует список радиокнопок. yii\helpers\BaseHtml
removeCssClass() Удаляет класс CSS из указанных опций. yii\helpers\BaseHtml
removeCssStyle() Удаляет указанный стиль CSS из HTML-опций. yii\helpers\BaseHtml
renderSelectOptions() Отображает теги опций, которые могут быть использованы методами dropDownList() и listBox(). yii\helpers\BaseHtml
renderTagAttributes() Отображает атрибуты HTML-тега. yii\helpers\BaseHtml
resetButton() Генерирует тег кнопки сброса. yii\helpers\BaseHtml
resetInput() Генерирует кнопку сброса типа input. yii\helpers\BaseHtml
script() Генерирует тег script. yii\helpers\BaseHtml
style() Генерирует тег style. yii\helpers\BaseHtml
submitButton() Генерирует тег кнопки отправки. yii\helpers\BaseHtml
submitInput() Генерирует кнопку отправки типа input. yii\helpers\BaseHtml
tag() Генерирует полный HTML-тег. yii\helpers\BaseHtml
textInput() Генерирует поле ввода текста. yii\helpers\BaseHtml
textarea() Генерирует поле ввода текста типа textarea. yii\helpers\BaseHtml
ul() Генерирует список без маркировки. yii\helpers\BaseHtml

Защищенные методы

Метод Описание Определено в
activeBooleanInput() Генерирует поле ввода булевого типа. Этот метод, в основном, вызывается методами activeCheckbox() и activeRadio(). yii\helpers\BaseHtml
activeListInput() Генерирует список полей ввода. yii\helpers\BaseHtml
booleanInput() Генерирует поле ввода булевого типа. yii\helpers\BaseHtml

Подробное описание свойств

$attributeOrder общедоступное статическое свойство

Предпочитаемый порядок атрибутов в теге. Это в основном влияет на порядок атрибутов, которые отображаются методом renderTagAttributes().

public static array $attributeOrder = ['type', 'id', 'class', 'name', 'value', 'href', 'src', 'srcset', 'form', 'action', 'method', 'selected', 'checked', 'readonly', 'disabled', 'multiple', 'size', 'maxlength', 'width', 'height', 'rows', 'cols', 'alt', 'title', 'rel', 'media']

$attributeRegex общедоступное статическое свойство (доступно начиная с версии 2.0.12)

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

public static string $attributeRegex = '/(^|.*\])([\w\.\+]+)(\[.*|$)/u'

$dataAttributes общедоступное статическое свойство (доступно начиная с версии 2.0.3)

Список атрибутов тега, которые следует специально обрабатывать, когда их значения являются массивами. В частности, если значение атрибута data равно ['name' => 'xyz', 'age' => 13], будут сгенерированы два атрибута вместо одного: data-name="xyz" data-age="13". 

public static array $dataAttributes = ['data', 'data-ng', 'ng']

$voidElements общедоступное статическое свойство

Список пустых элементов (имя элемента => 1)

См. также http://www.w3.org/TR/html-markup/syntax.html#void-element.

public static array $voidElements = ['area' => 1, 'base' => 1, 'br' => 1, 'col' => 1, 'command' => 1, 'embed' => 1, 'hr' => 1, 'img' => 1, 'input' => 1, 'keygen' => 1, 'link' => 1, 'meta' => 1, 'param' => 1, 'source' => 1, 'track' => 1, 'wbr' => 1]

Подробное описание методов

a() public static метод

Создаёт тег гиперссылки.

См. также yii\helpers\Url::to().

public static string a ( $text, $url = null, $options = [] )
$text string

Текст ссылки. Он НЕ будет кодироваться в HTML. Таким образом, вы можете передавать HTML-код, такой как тег изображения. Если этот текст поступает от конечных пользователей, рекомендуется использовать encode() для предотвращения атак XSS.
$url array|string|null

URL для тега гиперссылки. Этот параметр будет обработан методом yii\helpers\Url::to() и будет использован для атрибута "href" тега. Если этот параметр равен null, атрибут "href" не будет сгенерирован.

Если вы хотите использовать абсолютный URL, вы можете вызвать yii\helpers\Url::to() самостоятельно, перед передачей URL в этот метод, например так:

Html::a('link text', Url::to($url, true))
$options array

Параметры тега в виде пар имя-значение. Они будут отображены как атрибуты результирующего тега. Значения будут закодированы в HTML с помощью encode(). Если значение равно null, соответствующий атрибут не будет отображен. Подробнее о том, как отображаются атрибуты, см. renderTagAttributes().
return string

Сгенерированная гиперссылка

activeBooleanInput() защищённый статический метод (доступен с версии 2.0.9)

Генерирует элемент ввода булевого типа. Этот метод в основном вызывается методами activeCheckbox() и activeRadio().

protected static string activeBooleanInput ( $type, $model, $attribute, $options = [] )
$type string

Тип ввода. Может быть либо radio либо checkbox.

$model yii\base\Model

Объект модели
$attribute string

Имя атрибута или выражение. См. getAttributeName() для формата выражения атрибута.
$options array

Параметры тега в виде пар имя-значение. См. booleanInput() для деталей об используемых атрибутах.
return string

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

activeCheckbox() public static метод

Генерирует тег флажка вместе с меткой для заданного атрибута модели.

Этот метод сгенерирует атрибут "checked" в соответствии со значением атрибута модели.

public static string activeCheckbox ( $model, $attribute, $options = [] )
$model yii\base\Model

Объект модели
$attribute string

Имя атрибута или выражение. См. getAttributeName() для формата выражения атрибута.
$options array

Параметры тега в виде пар имя-значение. См. booleanInput() для деталей об используемых атрибутах.
return string

Сгенерированный тег флажка

activeCheckboxList() public static метод

Генерирует список флажков.

Список флажков позволяет выполнять множественный выбор, как и listBox(). В результате, соответствующее отправленное значение представляет собой массив. Выбор в списке флажков определяется значением атрибута модели.

public static string activeCheckboxList ( $model, $attribute, $items, $options = [] )
$model yii\base\Model

Объект модели
$attribute string

Имя атрибута или выражение. См. getAttributeName() для формата выражения атрибута.
$items array

Данные элементов, используемые для генерации флажков. Ключи массива — значения флажков, а значения массива — соответствующие метки. Обратите внимание, что метки НЕ будут закодированы в HTML, в то время как значения будут.
$options array

Параметры (имя => конфигурация) для тега контейнера списка флажков. Следующие параметры обрабатываются особым образом:

  • tag: string|false, имя тега контейнерного элемента. False для рендеринга флажка без контейнера. См. также tag().
  • unselect: string, значение, которое должно быть отправлено, когда ни один из флажков не выбран. Можно установить этот параметр в null, чтобы предотвратить отправку значения по умолчанию. Если этот параметр не установлен, будет отправлена пустая строка.
  • encode: boolean, кодировать ли метки флажков в HTML. По умолчанию true. Этот параметр игнорируется, если установлен параметр item.
  • separator: string, HTML-код, разделяющий элементы.
  • itemOptions: array, параметры для генерации тега флажка с помощью checkbox().

  • item: callable, обратный вызов, который можно использовать для настройки генерации HTML-кода, соответствующего одному элементу в $items. Подпись этого обратного вызова должна быть следующей:

    function ($index, $label, $name, $checked, $value)

    где $index — нулево-базовое индекс флажка в списке; $label — метка для флажка; и $name, $value и $checked представляют имя, значение и состояние выбранности флажка.

Подробности о том, как отображаются атрибуты, см. в renderTagAttributes().
return string

Сгенерированный список флажков

activeDropDownList() public static метод

Генерирует выпадающий список для заданного атрибута модели.

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

public static string activeDropDownList ( $model, $attribute, $items, $options = [] )
$model yii\base\Model

Объект модели
$attribute string

Имя атрибута или выражение. См. getAttributeName() для формата выражения атрибута.
$items array

Данные элементов списка. Ключи массива — значения элементов, а значения — соответствующие метки. Массив также может быть вложенным (т.е. некоторые значения массива являются массивами). Для каждого подмассива будет сгенерирована группа элементов, меткой которой является ключ, связанный с подмассивом. Если у вас есть список моделей данных, вы можете преобразовать их в указанный выше формат с помощью yii\helpers\ArrayHelper::map().

Обратите внимание, что значения и метки автоматически кодируются в HTML этим методом, и пробелы в метках также будут закодированы в HTML.
$options array

Параметры в виде пар имя-значение. Следующие параметры обрабатываются особенно:

  • prompt: string, текст подсказки, который будет отображен как первый элемент. С версии 2.0.11 вы можете использовать массив для переопределения значения и установки других атрибутов тега:

    ['text' => 'Please select', 'options' => ['value' => 'none', 'class' => 'prompt', 'label' => 'Select']],

  • options: array, атрибуты для тегов select option. Ключи массива должны быть допустимыми значениями элементов, а значения — дополнительными атрибутами соответствующих тегов option. Например,

    [
    'value1' => ['disabled' => true],
    'value2' => ['label' => 'value 2'],
];
  • groups: array, атрибуты для тегов optgroup. Структура аналогична структуре 'options', за исключением того, что ключи массива представляют метки optgroup, указанные в $items.
  • encodeSpaces: bool, кодировать ли пробелы в подсказке и значении опции с помощью символа  . По умолчанию false.
  • encode: bool, кодировать ли символы подсказки и значения опции. По умолчанию true. Этот параметр доступен с версии 2.0.3.

Остальные параметры будут отображены как атрибуты результирующего тега. Значения будут закодированы в HTML с помощью encode(). Если значение равно null, соответствующий атрибут не будет отображен. Подробнее о том, как отображаются атрибуты, см. в renderTagAttributes().
return string

Сгенерированный тег выпадающего списка

activeFileInput() public static method

Генерирует тег input файла для заданного атрибута модели.

Этот метод автоматически сгенерирует атрибуты тега "name" и "value" для атрибута модели, если они не указаны явно в $options.

public static string activeFileInput ( $model, $attribute, $options = [] )
$model yii\base\Model

Объект модели
$attribute string

Имя атрибута или выражение. Смотрите getAttributeName() для формата выражения атрибута.
$options array

Опции тега в виде пар имя-значение. Они будут отображены как атрибуты результирующего тега. Значения будут закодированы в HTML с использованием encode(). Смотрите renderTagAttributes() для получения подробностей о том, как отображаются атрибуты.
return string

Сгенерированный тег input

activeHiddenInput() public static method

Генерирует скрытый тег input для заданного атрибута модели.

Этот метод автоматически сгенерирует атрибуты тега "name" и "value" для атрибута модели, если они не указаны явно в $options.

public static string activeHiddenInput ( $model, $attribute, $options = [] )
$model yii\base\Model

Объект модели
$attribute string

Имя атрибута или выражение. Смотрите getAttributeName() для формата выражения атрибута.
$options array

Опции тега в виде пар имя-значение. Они будут отображены как атрибуты результирующего тега. Значения будут закодированы в HTML с использованием encode(). Смотрите renderTagAttributes() для получения подробностей о том, как отображаются атрибуты.
return string

Сгенерированный тег input

activeHint() public static method (доступно начиная с версии 2.0.4)

Генерирует тег hint для заданного атрибута модели.

Текст hint — это подсказка, связанная с атрибутом, полученная с помощью yii\base\Model::getAttributeHint(). Если содержимое подсказки получить не удаётся, метод вернёт пустую строку.

public static string activeHint ( $model, $attribute, $options = [] )
$model yii\base\Model

Объект модели
$attribute string

Имя атрибута или выражение. Смотрите getAttributeName() для формата выражения атрибута.
$options array

Опции тега в виде пар имя-значение. Они будут отображены как атрибуты результирующего тега. Значения будут закодированы в HTML с использованием encode(). Если значение равно null, соответствующий атрибут не будет отображён. Следующие опции обрабатываются особым образом:

  • hint: это задаёт отображаемую подсказку. Обратите внимание, что она НЕ будет кодироваться. Если она не установлена, yii\base\Model::getAttributeHint() будет вызван для получения подсказки для отображения (без кодирования).

Смотрите renderTagAttributes() для получения подробностей о том, как отображаются атрибуты.
return string

Сгенерированный тег hint

activeInput() public static method

Генерирует тег input для заданного атрибута модели.

Этот метод автоматически сгенерирует атрибуты тега "name" и "value" для атрибута модели, если они не указаны явно в $options.

public static string activeInput ( $type, $model, $attribute, $options = [] )
$type string

Тип input (например, 'text', 'password')
$model yii\base\Model

Объект модели
$attribute string

Имя атрибута или выражение. Смотрите getAttributeName() для формата выражения атрибута.
$options array

Опции тега в виде пар имя-значение. Они будут отображены как атрибуты результирующего тега. Значения будут закодированы в HTML с использованием encode(). Смотрите renderTagAttributes() для получения подробностей о том, как отображаются атрибуты.
return string

Сгенерированный тег input

activeLabel() public static method

Генерирует тег label для заданного атрибута модели.

Текст метки — это метка, связанная с атрибутом, полученная с помощью yii\base\Model::getAttributeLabel().

public static string activeLabel ( $model, $attribute, $options = [] )
$model yii\base\Model

Объект модели
$attribute string

Имя атрибута или выражение. Смотрите getAttributeName() для формата выражения атрибута.
$options array

Опции тега в виде пар имя-значение. Они будут отображены как атрибуты результирующего тега. Значения будут закодированы в HTML с использованием encode(). Если значение равно null, соответствующий атрибут не будет отображён. Следующие опции обрабатываются особым образом:

  • label: это задаёт отображаемую метку. Обратите внимание, что она НЕ будет кодироваться. Если она не установлена, yii\base\Model::getAttributeLabel() будет вызван для получения метки для отображения (после кодирования).

Смотрите renderTagAttributes() для получения подробностей о том, как отображаются атрибуты.
return string

Сгенерированный тег label

activeListBox() public static method

Генерирует список.

Выбор списка берётся из значения атрибута модели.

public static строка activeListBox ( $model, $attribute, $items, $options = [] )
$model yii\base\Model

Объект модели
$attribute строка

Имя или выражение атрибута. Смотрите getAttributeName() для формата выражения атрибута.
$items массив

Элементы данных опций. Ключи массива — значения опций, а значения массива — соответствующие метки опций. Массив также может быть вложенным (т.е. некоторые значения массива тоже являются массивами). Для каждого вложенного массива будет сгенерирована группа опций, метка которой является ключом, соответствующим вложенному массиву. Если у вас есть список моделей данных, вы можете преобразовать их в описанный выше формат, используя yii\helpers\ArrayHelper::map().

Обратите внимание, что значения и метки автоматически кодируются в HTML этим методом, а пробелы в метках также кодируются в HTML.
$options массив

Опции тега в виде пар имя-значение. Следующие опции обрабатываются особенно:

  • prompt: строка, текст подсказки, который будет отображаться в качестве первой опции. Начиная с версии 2.0.11, вы можете использовать массив для переопределения значения и установки других атрибутов тега:

    ['text' => 'Please select', 'options' => ['value' => 'none', 'class' => 'prompt', 'label' => 'Select']],

  • options: массив, атрибуты для тегов select option. Ключи массива должны быть допустимыми значениями опций, а значения массива — дополнительные атрибуты соответствующих тегов option. Например,

    [
    'value1' => ['disabled' => true],
    'value2' => ['label' => 'value 2'],
];
  • groups: массив, атрибуты для тегов optgroup. Структура этого массива аналогична структуре 'options', за исключением того, что ключи массива представляют метки optgroup, указанные в $items.
  • unselect: строка, значение, которое будет отправлено, когда ни одна опция не выбрана. При установке этого атрибута будет сгенерирован скрытый элемент, чтобы в случае выбора нескольких опций мы могли получить отправленное значение unselect.
  • encodeSpaces: bool, необходимо ли кодировать пробелы в подсказке опции и значении опции с   символом. По умолчанию false.
  • encode: bool, необходимо ли кодировать символы подсказки опции и значения опции. По умолчанию true. Эта опция доступна с версии 2.0.3.

Остальные опции будут отображаться в качестве атрибутов результирующего тега. Значения будут кодированы в HTML с помощью encode(). Если значение равно null, соответствующий атрибут не будет отображен. Подробнее о том, как отображаются атрибуты, см. renderTagAttributes().
return строка

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

activeListInput() защищенный статический метод

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

Этот метод в основном вызывается activeListBox(), activeRadioList() и activeCheckboxList().

protected static строка activeListInput ( $type, $model, $attribute, $items, $options = [] )
$type строка

Тип ввода. Может быть 'listBox', 'radioList' или 'checkBoxList'.
$model yii\base\Model

Объект модели
$attribute строка

Имя или выражение атрибута. Смотрите getAttributeName() для формата выражения атрибута.
$items массив

Данные элемента, используемые для генерации элементов ввода. Ключи массива — значения ввода, а значения массива — соответствующие метки. Обратите внимание, что метки НЕ будут закодированы в HTML, а значения будут.
$options массив

Опции (имя => конфигурация) для списка ввода. Поддерживаемые специальные опции зависят от типа ввода, указанного $type.

return строка

Сгенерированный список ввода

activePasswordInput() public static метод

Генерирует тег ввода пароля для заданного атрибута модели.

Этот метод будет автоматически генерировать атрибуты тега "name" и "value" для атрибута модели, если они не указаны явно в $options.

public static строка activePasswordInput ( $model, $attribute, $options = [] )
$model yii\base\Model

Объект модели
$attribute строка

Имя или выражение атрибута. Смотрите getAttributeName() для формата выражения атрибута.
$options массив

Опции тега в виде пар имя-значение. Они будут отображаться в качестве атрибутов результирующего тега. Значения будут кодированы в HTML с помощью encode(). Подробнее о том, как отображаются атрибуты, см. renderTagAttributes(). Следующие специальные опции распознаются:

  • maxlength: целое число|логическое, когда maxlength установлено в true и атрибут модели валидируется с помощью валидатора строк, опция maxlength примет значение yii\validators\StringValidator::$max. Эта опция доступна с версии 2.0.6.
return строка

Сгенерированный тег ввода

activeRadio() public static метод

Генерирует тег радиокнопки вместе с меткой для заданного атрибута модели.

Этот метод сгенерирует атрибут тега "checked" в соответствии со значением атрибута модели.

public static строка activeRadio ( $model, $attribute, $options = [] )
$model yii\base\Model

Объект модели
$attribute строка

Имя или выражение атрибута. Смотрите getAttributeName() для формата выражения атрибута.
$options массив

Опции тега в виде пар имя-значение. См. booleanInput() для получения информации об используемых атрибутах.
return строка

Сгенерированный тег радиокнопки

activeRadioList() public static метод

Генерирует список радиокнопок.

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

public static строка activeRadioList ( $model, $attribute, $items, $options = [] )
$model yii\base\Model

Объект модели
$attribute строка

Имя или выражение атрибута. Смотрите getAttributeName() для формата выражения атрибута.
$items массив

Элементы данных, используемые для генерации радиокнопок. Ключи массива — значения радиокнопок, а значения массива — соответствующие метки. Обратите внимание, что метки НЕ будут закодированы в HTML, а значения будут.
$options массив

Опции (имя => конфигурация) для тега контейнера списка радиокнопок. Следующие опции обрабатываются особенно:

  • tag: строка|false, имя тега контейнера элемента. False для рендеринга радиокнопок без контейнера. См. также tag().
  • unselect: строка, значение, которое должно быть отправлено, когда ни одна из радиокнопок не выбрана. Вы можете установить эту опцию в null, чтобы предотвратить отправку значения по умолчанию. Если эта опция не задана, будет отправлена пустая строка.
  • encode: boolean, необходимо ли кодировать метки чекбоксов в HTML. По умолчанию true. Эта опция игнорируется, если установлена опция item.
  • separator: строка, HTML-код, разделяющий элементы.
  • itemOptions: массив, опции для генерации тега радиокнопки с помощью radio().

  • item: callable, обратный вызов, который можно использовать для настройки генерации HTML-кода, соответствующего одному элементу в $items. Подпись этого обратного вызова должна быть:

    function ($index, $label, $name, $checked, $value)

    где $index — нулевой индекс радиокнопки в списке; $label — метка для радиокнопки; а $name, $value и $checked представляют имя, значение и состояние выбранности радиокнопки.

Подробности о том, как отображаются атрибуты, см. в renderTagAttributes().
return строка

Сгенерированный список радиокнопок

activeTextInput() public static method

Генерирует текстовое поле ввода для заданного атрибута модели.

Этот метод сгенерирует атрибуты тега "name" и "value" автоматически для атрибута модели, если они не указаны явно в $options.

public static string activeTextInput ( $model, $attribute, $options = [] )
$model yii\base\Model

Объект модели
$attribute string

Имя атрибута или выражение. См. getAttributeName() для формата выражения атрибута.
$options array

Параметры тега в виде пар имя-значение. Они будут отображены как атрибуты результирующего тега. Значения будут закодированы с помощью HTML с использованием encode(). Подробнее о том, как отображаются атрибуты, см. renderTagAttributes(). Признаются следующие специальные параметры:

  • maxlength: integer|boolean, когда maxlength имеет значение true и атрибут модели валидируется с помощью валидатора строк, параметр maxlength примет значение yii\validators\StringValidator::$max. Доступно начиная с версии 2.0.3.
return string

Сгенерированный тег input

activeTextarea() public static method

Генерирует тег textarea для заданного атрибута модели.

Значение атрибута модели будет использоваться как содержимое в textarea.

public static string activeTextarea ( $model, $attribute, $options = [] )
$model yii\base\Model

Объект модели
$attribute string

Имя атрибута или выражение. См. getAttributeName() для формата выражения атрибута.
$options array

Параметры тега в виде пар имя-значение. Они будут отображены как атрибуты результирующего тега. Значения будут закодированы с помощью HTML с использованием encode(). Подробнее о том, как отображаются атрибуты, см. renderTagAttributes(). Признаются следующие специальные параметры:

  • maxlength: integer|boolean, когда maxlength имеет значение true и атрибут модели валидируется с помощью валидатора строк, параметр maxlength примет значение yii\validators\StringValidator::$max. Этот параметр доступен начиная с версии 2.0.6.
return string

Сгенерированный тег textarea

addCssClass() public static method

Добавляет CSS-класс (или несколько классов) в указанные параметры.

Если CSS-класс уже есть в параметрах, он не будет добавлен повторно. Если спецификация класса в заданных параметрах является массивом, и некоторый класс размещен там с именованным (строковым) ключом, переопределение такого ключа не повлияет. Например:

$options = ['class' => ['persistent' => 'initial']];
Html::addCssClass($options, ['persistent' => 'override']);
var_dump($options['class']); // outputs: array('persistent' => 'initial');
public static void addCssClass ( &$options, $class )
$options array

Параметры, которые нужно изменить.
$class string|array

Добавляемый(ые) CSS-класс(ы)

addCssStyle() public static method

Добавляет указанный CSS-стиль в параметры HTML.

Если в параметрах уже существует элемент style, новый стиль будет объединён с существующим. Если CSS-свойство существует как в новом, так и в старом стиле, старое может быть перезаписано, если $overwrite равно true.

Например,

Html::addCssStyle($options, 'width: 100px; height: 200px');

См. также:

  • removeCssStyle()
  • cssStyleFromArray()
  • cssStyleToArray()
public static void addCssStyle ( &$options, $style, $overwrite = true )
$options array

Изменяемые параметры HTML.
$style string|array

Новая строка стиля (например, 'width: 100px; height: 200px') или массив (например, ['width' => '100px', 'height' => '200px']).
$overwrite boolean

Нужно ли перезаписывать существующие CSS-свойства, если новый стиль также их содержит.

beginForm() public static method

Генерирует стартовый тег формы.

См. также endForm().

public static string beginForm ( $action = '', $method = 'post', $options = [] )
$action array|string

URL действия формы. Этот параметр будет обработан функцией yii\helpers\Url::to().
$method string

Метод отправки формы, например, "post", "get", "put", "delete" (регистронезависимо). Поскольку большинство браузеров поддерживают только "post" и "get", если заданы другие методы, они будут смоделированы с помощью "post", и будет добавлен скрытый input, содержащий фактический тип метода. Подробнее см. yii\web\Request::$methodParam.
$options array

Параметры тега в виде пар имя-значение. Они будут отображены как атрибуты результирующего тега. Значения будут закодированы с помощью HTML с использованием encode(). Если значение равно null, соответствующий атрибут не будет отображён. Подробнее о том, как отображаются атрибуты, см. renderTagAttributes().

Специальные параметры:

  • csrf: нужно ли генерировать скрытый input CSRF. По умолчанию true.
return string

Сгенерированный стартовый тег формы.

beginTag() public static method

Генерирует стартовый тег.

См. также:

  • endTag()
  • tag()
public static string beginTag ( $name, $options = [] )
$name string|boolean|null

Имя тега. Если $name равно null или false, соответствующее содержимое будет отображено без тега.
$options array

Параметры тега в виде пар имя-значение. Они будут отображены как атрибуты результирующего тега. Значения будут закодированы с помощью HTML с использованием encode(). Если значение равно null, соответствующий атрибут не будет отображён. Подробнее о том, как отображаются атрибуты, см. renderTagAttributes().
return string

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

booleanInput() protected static method (доступен начиная с версии 2.0.9)

Генерирует boolean input.

protected static строка booleanInput ( $type, $name, $checked = false, $options = [] )
$type строка

Тип ввода. Может быть либо radio либо checkbox.
$name строка

Атрибут name.
$checked булево

Выбран ли чекбокс.
$options массив

Параметры тега в виде пар имя-значение. Следующие параметры обрабатываются особенно:

  • uncheck: строка, значение, связанное со сброшенным состоянием чекбокса. При наличии этого атрибута будет сгенерирован скрытый элемент ввода, так что если чекбокс не выбран и отправлен, значение этого атрибута всё равно будет отправлено на сервер через скрытый элемент ввода.
  • label: строка, метка, отображаемая рядом с чекбоксом. Она НЕ будет закодирована в HTML. Поэтому вы можете передавать HTML-код, такой как тег изображения. Если это данные от конечных пользователей, вы должны закодировать их, чтобы предотвратить атаки XSS. Когда этот параметр задан, чекбокс будет заключён в тег label.
  • labelOptions: массив, атрибуты тега label. Не устанавливайте этот параметр, если не задан параметр "label".

Остальные параметры будут отображены как атрибуты результирующего тега checkbox. Значения будут закодированы в HTML с помощью encode(). Если значение равно null, соответствующий атрибут не будет отображён. Подробнее о том, как рендерятся атрибуты, см. renderTagAttributes().
return строка

Сгенерированный тег checkbox

button() public static method

Генерирует тег кнопки.

public static строка button ( $content = 'Button', $options = [] )
$content строка

Содержимое, заключённое внутри тега кнопки. Оно НЕ будет закодировано в HTML. Поэтому вы можете передавать HTML-код, такой как тег изображения. Если это данные от конечных пользователей, следует рассмотреть кодирование для предотвращения атак XSS.
$options массив

Параметры тега в виде пар имя-значение. Они будут отображены как атрибуты результирующего тега. Значения будут закодированы в HTML с помощью encode(). Если значение равно null, соответствующий атрибут не будет отображён. Подробнее о том, как рендерятся атрибуты, см. renderTagAttributes().
return строка

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

buttonInput() public static method

Генерирует кнопку ввода.

public static строка buttonInput ( $label = 'Button', $options = [] )
$label строка

Атрибут value. Если он равен null, атрибут value не будет сгенерирован.
$options массив

Параметры тега в виде пар имя-значение. Они будут отображены как атрибуты результирующего тега. Значения будут закодированы в HTML с помощью encode(). Если значение равно null, соответствующий атрибут не будет отображён. Подробнее о том, как рендерятся атрибуты, см. renderTagAttributes().
return строка

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

checkbox() public static method

Генерирует элемент ввода типа checkbox.

public static строка checkbox ( $name, $checked = false, $options = [] )
$name строка

Атрибут name.
$checked булево

Выбран ли чекбокс.
$options массив

Параметры тега в виде пар имя-значение. Подробнее о поддерживаемых атрибутах см. booleanInput().
return строка

Сгенерированный тег checkbox

checkboxList() public static method

Генерирует список чекбоксов.

Список чекбоксов позволяет осуществлять множественный выбор, как и listBox(). В результате соответствующее отправленное значение является массивом.

public static строка checkboxList ( $name, $selection = null, $items = [], $options = [] )
$name строка

Атрибут name каждого чекбокса.
$selection строка|массив|null

Выбранное(ые) значение(я). Строка для одиночного выбора или массив для множественного выбора.
$items массив

Данные для генерации чекбоксов. Ключи массива — значения чекбоксов, а значения массива — соответствующие метки.
$options массив

Параметры (имя => конфигурация) для тега контейнера списка чекбоксов. Следующие параметры обрабатываются особенно:

  • tag: строка|false, имя тега контейнера. False для рендеринга чекбоксов без контейнера. См. также tag().
  • unselect: строка, значение, которое должно быть отправлено, когда ни один чекбокс не выбран. При задании этого параметра будет сгенерирован скрытый элемент ввода.
  • encode: булево, нужно ли кодировать метки чекбоксов в HTML. По умолчанию true. Этот параметр игнорируется, если задан параметр item.
  • separator: строка, HTML-код, разделяющий элементы.
  • itemOptions: массив, параметры для генерации тега чекбокса с помощью checkbox().

  • item: функция обратного вызова, которая может использоваться для настройки генерации HTML-кода, соответствующего одному элементу в $items. Подпись этой функции обратного вызова:

    function ($index, $label, $name, $checked, $value)

    где $index — нулевой индекс чекбокса в списке; $label — метка для чекбокса; а $name, $value и $checked — имя, значение и статус выбора чекбокса ввода соответственно.

Подробнее о том, как рендерятся атрибуты, см. renderTagAttributes().
return строка

Сгенерированный список чекбоксов

csrfMetaTags() public static method

Генерирует мета-теги, содержащие информацию о CSRF-токене.

См. также yii\web\Request::$enableCsrfValidation.

public static строка csrfMetaTags ( )
return строка

Сгенерированные мета-теги

cssFile() public static method

Генерирует тег link, который ссылается на внешний CSS-файл.

См. также yii\helpers\Url::to().

public static строка cssFile ( $url, $options = [] )
$url массив|строка

URL внешнего CSS-файла. Этот параметр будет обработан с помощью yii\helpers\Url::to().
$options массив

Параметры тега в виде пар имя-значение. Следующие параметры обрабатываются особенно:

  • condition: задаёт условные комментарии для IE, например, lt IE 9. Когда это указано, сгенерированный link тег будет заключён в условные комментарии. Это главным образом полезно для поддержки старых версий браузеров IE.
  • noscript: если установлено в true, link тег будет заключён в <noscript> теги.

Остальные параметры будут отображены как атрибуты результирующего тега link. Значения будут закодированы в HTML с помощью encode(). Если значение равно null, соответствующий атрибут не будет отображён. Подробнее о том, как рендерятся атрибуты, см. renderTagAttributes().
return строка

Сгенерированный тег link

cssStyleFromArray() public static method

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

Например,

print_r(Html::cssStyleFromArray(['width' => '100px', 'height' => '200px']));
// will display: 'width: 100px; height: 200px;'
public static string cssStyleFromArray ( array $style )
$style array

Массив стилей CSS. Ключи массива — имена свойств CSS, значения — соответствующие значения свойств CSS.
return string

Строка стилей CSS. Если массив стилей пуст, будет возвращено null.

cssStyleToArray() public static method

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

Ключи массива — имена свойств CSS, значения — соответствующие значения свойств CSS.

Например,

print_r(Html::cssStyleToArray('width: 100px; height: 200px;'));
// will display: ['width' => '100px', 'height' => '200px']
public static array cssStyleToArray ( $style )
$style string

Строка стилей CSS
return array

Массивное представление стиля CSS

decode() public static method

Декодирует специальные HTML-сущности обратно в соответствующие символы.

Это противоположное действие encode().

См. также:

  • encode()
  • http://www.php.net/manual/en/function.htmlspecialchars-decode.php
public static string decode ( $content )
$content string

Контент для декодирования
return string

Декодированный контент

dropDownList() public static method

Генерирует выпадающий список.

public static string dropDownList ( $name, $selection = null, $items = [], $options = [] )
$name string

Имя ввода
$selection string|array|null

Выбранное(ые) значение(я). Строка для единичного выбора или массив для множественного выбора.
$items array

Элементы данных опций. Ключи массива — значения опций, значения — соответствующие метки опций. Массив также может быть вложенным (т.е. некоторые значения массива тоже являются массивами). Для каждого подмассива будет сгенерирована группа опций, метка которой — ключ, связанный с подмассивом. Если у вас есть список моделей данных, вы можете преобразовать их в описанный выше формат с помощью yii\helpers\ArrayHelper::map().

Обратите внимание, что значения и метки будут автоматически закодированы в HTML этим методом, а пробелы в метках также будут закодированы в HTML.
$options array

Параметры тега в виде пар имя-значение. Следующие параметры обрабатываются специально:

  • prompt: строка, текст подсказки, который будет отображен в качестве первой опции. С версии 2.0.11 вы можете использовать массив для переопределения значения и установки других атрибутов тега:

    ['text' => 'Please select', 'options' => ['value' => 'none', 'class' => 'prompt', 'label' => 'Select']],

  • options: массив, атрибуты тегов select option. Ключи массива должны быть допустимыми значениями опций, а значения массива — дополнительные атрибуты соответствующих тегов option. Например,

    [
    'value1' => ['disabled' => true],
    'value2' => ['label' => 'value 2'],
];
  • groups: массив, атрибуты тегов optgroup. Структура этого похожа на структуру 'options', за исключением того, что ключи массива представляют метки optgroup, указанные в $items.
  • encodeSpaces: bool, нужно ли кодировать пробелы в подсказке опции и значении опции с &nbsp; символом. По умолчанию false.
  • encode: bool, нужно ли кодировать символы подсказки опции и значения опции. По умолчанию true. Этот параметр доступен с 2.0.3.

Остальные параметры будут отображены как атрибуты результирующего тега. Значения будут закодированы в HTML с помощью encode(). Если значение равно null, соответствующий атрибут не будет отображен. Подробности о том, как отображаются атрибуты, см. в renderTagAttributes().
return string

Сгенерированный тег выпадающего списка

encode() public static method

Кодирует специальные символы в HTML-сущности.

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

См. также:

  • decode()
  • http://www.php.net/manual/en/function.htmlspecialchars.php
public static string encode ( $content, $doubleEncode = true )
$content string

Контент для кодирования
$doubleEncode boolean

Нужно ли кодировать HTML-сущности в $content. Если false, HTML-сущности в $content не будут далее закодированы.
return string

Закодированный контент

endForm() public static method

Генерирует закрывающий тег формы.

См. также beginForm().

public static string endForm ( )
return string

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

endTag() public static method

Генерирует закрывающий тег.

См. также:

  • beginTag()
  • tag()
public static string endTag ( $name )
$name string|boolean|null

Имя тега. Если $name равен null или false, соответствующий контент будет отображён без тега.
return string

Сгенерированный закрывающий тег

error() public static method

Генерирует тег, содержащий первую ошибку валидации указанного атрибута модели.

Обратите внимание, что даже если ошибки валидации нет, этот метод всё равно вернёт пустой тег ошибки.

public static string error ( $model, $attribute, $options = [] )
$model yii\base\Model

Объект модели
$attribute string

Имя атрибута или выражение. См. getAttributeName() для формата выражения атрибута.
$options array

Параметры тега в виде пар имя-значение. Значения будут закодированы в HTML с помощью encode(). Если значение равно null, соответствующий атрибут не будет отображен.

Следующие параметры обрабатываются специально:

  • tag: это определяет имя тега. Если не задано, будет использоваться "div". См. также tag().
  • encode: boolean, если установлено в false, сообщение об ошибке не будет закодировано.

Подробности о том, как отображаются атрибуты, см. в renderTagAttributes().
return string

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

errorSummary() public static method

Генерирует сводку ошибок валидации.

Если ошибок валидации нет, все равно будет сгенерирована пустая разметка сводки ошибок, но она будет скрыта.

public static string errorSummary ( $models, $options = [] )
$models yii\base\Model|yii\base\Model[]

Модель(и), ошибки валидации которых нужно отобразить.
$options array

Параметры тега в виде пар имя-значение. Следующие параметры обрабатываются специально:

  • header: строка, HTML-заголовок для сводки ошибок. Если не задан, будет использована строка-подсказка по умолчанию.
  • footer: строка, HTML-подвал для сводки ошибок. По умолчанию пустая строка.
  • encode: boolean, если установлено в false, сообщения об ошибках не будут закодированы. По умолчанию true.
  • showAllErrors: boolean, если установлено в true, будет показано каждое сообщение об ошибке для каждого атрибута, в противном случае будет показано только первое сообщение об ошибке для каждого атрибута. По умолчанию false. Параметр доступен начиная с версии 2.0.10.

Остальные параметры будут отображены как атрибуты контейнерного тега.
return string

Сгенерированная сводка ошибок

escapeJsRegularExpression() public static method (доступно с версии 2.0.6)

Экранирует регулярное выражение для использования в JavaScript

public static string escapeJsRegularExpression ( $regexp )
$regexp string

Регулярное выражение, которое нужно экранировать.
return string

Результат экранирования.

fileInput() public static method

Генерирует поле ввода файла.

Для использования поля ввода файла необходимо установить атрибут "enctype" окружающей формы в "multipart/form-data". После отправки формы информацию об загруженном файле можно получить через $_FILES[$name] (см. документацию PHP).

public static string fileInput ( $name, $value = null, $options = [] )
$name string

Атрибут name.
$value string

Атрибут value. Если null, атрибут value не будет сгенерирован.
$options array

Параметры тега в виде пар имя-значение. Они будут отображены как атрибуты результирующего тега. Значения будут закодированы в HTML с помощью encode(). Если значение равно null, соответствующий атрибут не будет отображен. Подробности о том, как отображаются атрибуты, см. в renderTagAttributes().
return string

Сгенерированный тег ввода файла

getAttributeName() public static method

Возвращает реальное имя атрибута из заданного выражения атрибута.

Выражение атрибута — это имя атрибута, префикс и/или суффикс с индексами массива. Оно в основном используется при вводе табличных данных и/или данных типа массив. Ниже приведены примеры:

  • [0]content используется при вводе табличных данных для представления атрибута "content" для первой модели в табличном вводе;
  • dates[0] представляет первый элемент массива атрибута "dates";
  • [0]dates[0] представляет первый элемент массива атрибута "dates" для первой модели в табличном вводе.

Если у $attribute нет ни префикса, ни суффикса, он возвращается без изменений.

public static string getAttributeName ( $attribute )
$attribute string

Имя атрибута или выражение
return string

Имя атрибута без префикса и суффикса.
throws yii\base\InvalidParamException

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

getAttributeValue() public static method

Возвращает значение указанного имени атрибута или выражения.

Для выражения атрибута, например, [0]dates[0], этот метод вернет значение $model->dates[0]. Подробнее об выражениях атрибутов см. getAttributeName().

Если значение атрибута является экземпляром yii\db\ActiveRecordInterface или массивом таких экземпляров, вместо него(них) будет возвращено(ы) первичное(ые) значение(я) объекта(ов) AR.

public static string|array getAttributeValue ( $model, $attribute )
$model yii\base\Model

Объект модели
$attribute string

Имя атрибута или выражение
return string|array

Соответствующее значение атрибута
throws yii\base\InvalidParamException

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

getInputId() public static method

Генерирует соответствующий идентификатор ввода для указанного имени атрибута или выражения.

Этот метод преобразует результат getInputName() в допустимый идентификатор ввода. Например, если getInputName() возвращает Post[content], этот метод вернет post-content.

public static string getInputId ( $model, $attribute )
$model yii\base\Model

Объект модели
$attribute string

Имя атрибута или выражение. См. getAttributeName() для объяснения выражения атрибута.
return string

Сгенерированный идентификатор ввода
throws yii\base\InvalidParamException

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

getInputName() public static method

Генерирует подходящее имя ввода для указанного имени атрибута или выражения.

Этот метод генерирует имя, которое может быть использовано в качестве имени ввода для сбора пользовательского ввода для указанного атрибута. Имя генерируется в соответствии с именем формы модели и заданным именем атрибута. Например, если имя формы модели Post равно Post, то имя ввода, сгенерированное для атрибута content, будет Post[content].

См. getAttributeName() для объяснения выражения атрибута.

public static string getInputName ( $model, $attribute )
$model yii\base\Model

Объект модели
$attribute string

Имя атрибута или выражение
return string

Сгенерированное имя ввода
throws yii\base\InvalidParamException

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

hiddenInput() public static method

Генерирует скрытое поле ввода.

public static string hiddenInput ( $name, $value = null, $options = [] )
$name string

Атрибут name.
$value string

Атрибут value. Если null, атрибут value не будет сгенерирован.
$options array

Параметры тега в виде пар имя-значение. Они будут отображены как атрибуты результирующего тега. Значения будут закодированы в HTML с помощью encode(). Если значение равно null, соответствующий атрибут не будет отображен. Подробности о том, как отображаются атрибуты, см. в renderTagAttributes().
return string

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

img() public static method

Генерирует тег изображения.

public static строка img ( $src, $options = [] )
$src массив|строка

URL изображения. Этот параметр будет обработан с помощью yii\helpers\Url::to().
$options массив

Параметры тега в виде пар имя-значение. Они будут отображены в качестве атрибутов результирующего тега. Значения будут закодированы с помощью encode(). Если значение равно null, соответствующий атрибут не будет отображён. Подробности о том, как отображаются атрибуты, см. в renderTagAttributes().

Начиная с версии 2.0.12, можно передать параметр srcset в виде массива, ключи которого — описания, а значения — URL-адреса. Все URL-адреса будут обработаны с помощью yii\helpers\Url::to().
return строка

Сгенерированный тег изображения.

input() public static метод

Генерирует элемент ввода заданного типа.

public static строка input ( $type, $name = null, $value = null, $options = [] )
$type строка

Атрибут типа.
$name строка

Атрибут имени. Если null, атрибут имени не будет сгенерирован.
$value строка

Атрибут значения. Если null, атрибут значения не будет сгенерирован.
$options массив

Параметры тега в виде пар имя-значение. Они будут отображены в качестве атрибутов результирующего тега. Значения будут закодированы с помощью encode(). Если значение равно null, соответствующий атрибут не будет отображён. Подробности о том, как отображаются атрибуты, см. в renderTagAttributes().
return строка

Сгенерированный тег ввода.

jsFile() public static метод

Генерирует тег script, ссылающийся на внешний JavaScript-файл.

См. также yii\helpers\Url::to().

public static строка jsFile ( $url, $options = [] )
$url строка

URL внешнего JavaScript-файла. Этот параметр будет обработан с помощью yii\helpers\Url::to().
$options массив

Параметры тега в виде пар имя-значение. Следующий параметр обрабатывается особенно:

  • condition: задаёт условные комментарии для IE, например, lt IE 9. Если он указан, сгенерированный тег script будет заключён в условные комментарии. Это в основном полезно для поддержки старых версий браузера IE.

Остальные параметры будут отображены как атрибуты результирующего тега script. Значения будут закодированы с помощью encode(). Если значение равно null, соответствующий атрибут не будет отображён. Подробности о том, как отображаются атрибуты, см. в renderTagAttributes().
return строка

Сгенерированный тег script

label() public static метод

Генерирует тег label.

public static строка label ( $content, $for = null, $options = [] )
$content строка

Текст метки. Он НЕ будет закодирован в HTML. Поэтому вы можете передать HTML-код, например, тег изображения. Если текст получен от конечного пользователя, вы должны encode() его, чтобы предотвратить атаки XSS.
$for строка

Идентификатор HTML-элемента, с которым связана эта метка. Если null, атрибут "for" не будет сгенерирован.
$options массив

Параметры тега в виде пар имя-значение. Они будут отображены в качестве атрибутов результирующего тега. Значения будут закодированы с помощью encode(). Если значение равно null, соответствующий атрибут не будет отображён. Подробности о том, как отображаются атрибуты, см. в renderTagAttributes().
return строка

Сгенерированный тег label.

listBox() public static метод

Генерирует выпадающий список.

public static строка listBox ( $name, $selection = null, $items = [], $options = [] )
$name строка

Имя поля ввода.
$selection строка|массив|null

Выбранное(ые) значение(я). Строка для одиночного или массив для множественного выбора.
$items массив

Данные элементов опций. Ключи массива — значения опций, а значения массива — соответствующие подписи опций. Массив также может быть вложенным (т.е. некоторые значения массива являются массивами). Для каждого подмассива будет сгенерирована группа опций, чья подпись — ключ, связанный с подмассивом. Если у вас есть список моделей данных, вы можете преобразовать их в описанный выше формат, используя yii\helpers\ArrayHelper::map().

Обратите внимание, что значения и подписи будут автоматически закодированы в HTML этим методом, а пробелы в подписях также будут закодированы в HTML.
$options массив

Параметры тега в виде пар имя-значение. Следующие параметры обрабатываются особенно:

  • prompt: строка, текст подсказки, который будет отображён в качестве первой опции. Начиная с версии 2.0.11, вы можете использовать массив для переопределения значения и установки других атрибутов тега:

    ['text' => 'Please select', 'options' => ['value' => 'none', 'class' => 'prompt', 'label' => 'Select']],

  • options: массив, атрибуты для тегов select option. Ключи массива должны быть допустимыми значениями опций, а значения массива — дополнительные атрибуты для соответствующих тегов опций. Например,

    [
    'value1' => ['disabled' => true],
    'value2' => ['label' => 'value 2'],
];
  • groups: массив, атрибуты для тегов optgroup. Структура этого аналогична структуре 'options', за исключением того, что ключи массива представляют подписи optgroup, указанные в $items.
  • unselect: строка, значение, которое будет отправлено, когда ни одна опция не выбрана. Если этот атрибут установлен, будет сгенерировано скрытое поле, чтобы в режиме множественного выбора, даже если ни одна опция не выбрана, мы всё ещё могли получить отправленное значение unselect.
  • encodeSpaces: bool, кодировать ли пробелы в подсказке и значении опции символом &nbsp;. По умолчанию false.
  • encode: bool, кодировать ли символы подсказки и значения опции. По умолчанию true. Этот параметр доступен с 2.0.3.

Остальные параметры будут отображены как атрибуты результирующего тега. Значения будут закодированы с помощью encode(). Если значение равно null, соответствующий атрибут не будет отображён. Подробности о том, как отображаются атрибуты, см. в renderTagAttributes().
return строка

Сгенерированный тег выпадающего списка.

mailto() public static метод

Генерирует гиперссылку mailto.

public static строка mailto ( $text, $email = null, $options = [] )
$text строка

Текст ссылки. Он НЕ будет закодирован в HTML. Поэтому вы можете передать HTML-код, например, тег изображения. Если текст получен от конечного пользователя, вы должны закодировать его с помощью encode(), чтобы предотвратить атаки XSS.
$email строка

Адрес электронной почты. Если null, первый параметр (текст ссылки) будет обработан как адрес электронной почты.
$options массив

Параметры тега в виде пар имя-значение. Они будут отображены в качестве атрибутов результирующего тега. Значения будут закодированы с помощью encode(). Если значение равно null, соответствующий атрибут не будет отображён. Подробности о том, как отображаются атрибуты, см. в renderTagAttributes().
return строка

Сгенерированная ссылка mailto.

ol() public static метод

Генерирует упорядоченный список.

public static string ol ( $items, $options = [] )
$items array|Traversable

Элементы для создания списка. Каждый элемент генерирует один элемент списка. Обратите внимание, что элементы будут автоматически закодированы в HTML, если $options['encode'] не задано или равно true.
$options array

Параметры (имя => конфигурация) для списка радиокнопок. Поддерживаются следующие параметры:

  • encode: boolean, нужно ли кодировать элементы в HTML. По умолчанию true. Этот параметр игнорируется, если указан параметр item.
  • itemOptions: array, атрибуты HTML для тегов li. Этот параметр игнорируется, если указан параметр item.

  • item: callable, обратный вызов, используемый для генерации каждого отдельного элемента списка. Подпись этого обратного вызова должна быть:

    function ($item, $index)

    где $index — ключ массива, соответствующий $item в $items. Обратный вызов должен возвращать весь тег элемента списка.

Подробности о том, как рендерятся атрибуты, см. в renderTagAttributes().
return string

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

passwordInput() public static method

Генерирует поле ввода пароля.

public static string passwordInput ( $name, $value = null, $options = [] )
$name string

Атрибут name.
$value string

Атрибут value. Если null, атрибут value не будет сгенерирован.
$options array

Параметры тега в виде пар имя-значение. Эти параметры будут отображены как атрибуты результирующего тега. Значения будут закодированы в HTML с помощью encode(). Если значение null, соответствующий атрибут не будет отображен. Подробности о том, как рендерятся атрибуты, см. в renderTagAttributes().
return string

Сгенерированный тег ввода пароля

radio() public static method

Генерирует элемент ввода типа радиокнопка.

public static string radio ( $name, $checked = false, $options = [] )
$name string

Атрибут name.
$checked boolean

Флаг, указывающий, должна ли быть выбрана радиокнопка.
$options array

Параметры тега в виде пар имя-значение. Подробности об принимаемых атрибутах см. в booleanInput().
return string

Сгенерированный тег радиокнопки

radioList() public static method

Генерирует список радиокнопок.

Список радиокнопок похож на список чекбоксов, но позволяет выбрать только один элемент.

public static string radioList ( $name, $selection = null, $items = [], $options = [] )
$name string

Атрибут name каждой радиокнопки.
$selection string|array|null

Выбранное значение(я). Строка для единичного или массив для множественного выбора.
$items array

Данные для элементов, используемые для генерации радиокнопок. Ключи массива — значения радиокнопок, значения массива — соответствующие метки.
$options array

Параметры (имя => конфигурация) для контейнера списка радиокнопок. Следующие параметры обрабатываются специально:

  • tag: string|false, имя тега контейнера. False для рендеринга радиокнопок без контейнера. См. также tag().
  • unselect: string, значение, которое должно быть отправлено, когда ни одна радиокнопка не выбрана. Указав этот параметр, будет сгенерирован скрытый элемент ввода.
  • encode: boolean, нужно ли кодировать метки чекбоксов в HTML. По умолчанию true. Этот параметр игнорируется, если установлен параметр item.
  • separator: string, HTML-код, разделяющий элементы.
  • itemOptions: array, параметры для генерации тега радиокнопки с помощью radio().

  • item: callable, обратный вызов, который может быть использован для настройки генерации HTML-кода, соответствующего одному элементу в $items. Подпись этого обратного вызова должна быть:

    function ($index, $label, $name, $checked, $value)

    где $index — нумерация радиокнопки в списке; $label — метка радиокнопки; $name, $value и $checked — имя, значение и состояние выбора радиокнопки соответственно.

Подробности о том, как рендерятся атрибуты, см. в renderTagAttributes().
return string

Сгенерированный список радиокнопок

removeCssClass() public static method

Удаляет CSS-класс из указанных параметров.

public static void removeCssClass ( &$options, $class )
$options array

Параметры, которые нужно изменить.
$class string|array

CSS-класс(ы) для удаления

removeCssStyle() public static method

Удаляет указанный CSS-стиль из HTML-параметров.

Например,

Html::removeCssStyle($options, ['width', 'height']);

См. также addCssStyle().

public static void removeCssStyle ( &$options, $properties )
$options array

HTML-параметры, которые нужно изменить.
$properties string|array

CSS-свойства для удаления. Можно использовать строку, если удаляется одно свойство.

renderSelectOptions() public static method

Рендерит теги option, которые могут использоваться в dropDownList() и listBox().

public static string renderSelectOptions ( $selection, $items, &$tagOptions = [] )
$selection string|array|null

Выбранное значение(я). Строка для единичного или массив для множественного выбора.
$items array

Данные для опций. Ключи массива — значения опций, значения массива — соответствующие метки опций. Массив также может быть вложенным (т.е. некоторые значения массива являются массивами). Для каждого подмассива будет сгенерирована группа опций, метка которой — ключ, связанный с подмассивом. Если у вас есть список моделей данных, вы можете преобразовать их в указанный выше формат, используя yii\helpers\ArrayHelper::map().

Обратите внимание, что значения и метки будут автоматически закодированы в HTML этим методом, а пробелы в метках также будут закодированы в HTML.
$tagOptions array

Параметр $options, который передаётся в вызов dropDownList() или listBox(). Этот метод извлечёт элементы "prompt", "options" и "groups", если они есть. Подробности см. в dropDownList().
return string

Сгенерированные опции списка

renderTagAttributes() public static method

Рендерит атрибуты HTML-тега.

Атрибуты, значения которых являются булевыми, будут обрабатываться как булевые атрибуты.

Атрибуты, значения которых null, не будут рендериться.

Значения атрибутов будут закодированы в HTML с помощью encode().

Атрибут "data" обрабатывается особым образом, когда получает значение массива. В этом случае массив будет «расширен», и будут отображены атрибуты списка данных. Например, если 'data' => ['id' => 1, 'name' => 'yii'], то это будет отображено: data-id="1" data-name="yii". Кроме того, 'data' => ['params' => ['id' => 1, 'name' => 'yii'], 'status' => 'ok'] будет отображено как: data-params='{"id":1,"name":"yii"}' data-status="ok".

public static строка renderTagAttributes ( $attributes )
$attributes массив

Атрибуты для отображения. Значения атрибутов будут закодированы в HTML с помощью encode().
return строка

Результат рендеринга. Если атрибуты не пустые, они будут отображены в строке с начальным пробелом (чтобы их можно было непосредственно добавить к имени тега в теге). Если атрибутов нет, будет возвращена пустая строка.

resetButton() public static метод

Создаёт тег кнопки сброса.

public static строка resetButton ( $content = 'Сброс', $options = [] )
$content строка

Содержимое, заключённое внутри тега кнопки. Оно НЕ будет закодировано в HTML. Поэтому вы можете передавать HTML-код, например, тег изображения. Если содержимое поступает от конечных пользователей, рекомендуется использовать encode() для предотвращения атак XSS.
$options массив

Параметры тега в виде пар имя-значение. Они будут отображены как атрибуты результирующего тега. Значения будут закодированы в HTML с помощью encode(). Если значение равно null, соответствующий атрибут не будет отображён. Подробности о том, как отображаются атрибуты, см. в renderTagAttributes().
return строка

Созданный тег кнопки сброса

resetInput() public static метод

Создаёт кнопку сброса типа input.

public static строка resetInput ( $label = 'Сброс', $options = [] )
$label строка

Атрибут value. Если он равен null, атрибут value не будет сгенерирован.
$options массив

Атрибуты тега кнопки. Значения будут закодированы в HTML с помощью encode(). Атрибуты со значением null будут проигнорированы и не включены в возвращаемый тег. Подробности о том, как отображаются атрибуты, см. в renderTagAttributes().
return строка

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

script() public static метод

Создаёт тег script.

public static строка script ( $content, $options = [] )
$content строка

Содержимое скрипта
$options массив

Параметры тега в виде пар имя-значение. Они будут отображены как атрибуты результирующего тега. Значения будут закодированы в HTML с помощью encode(). Если значение равно null, соответствующий атрибут не будет отображён. Подробности о том, как отображаются атрибуты, см. в renderTagAttributes().
return строка

Созданный тег script

style() public static метод

Создаёт тег style.

public static строка style ( $content, $options = [] )
$content строка

Содержимое стиля
$options массив

Параметры тега в виде пар имя-значение. Они будут отображены как атрибуты результирующего тега. Значения будут закодированы в HTML с помощью encode(). Если значение равно null, соответствующий атрибут не будет отображён. Подробности о том, как отображаются атрибуты, см. в renderTagAttributes().
return строка

Созданный тег style

submitButton() public static метод

Создаёт тег кнопки отправки.

Будьте внимательны при именовании элементов формы, таких как кнопки отправки. Согласно документации jQuery https://api.jquery.com/submit/, существуют некоторые зарезервированные имена, которые могут вызвать конфликты, например, submit, length, или method.

public static строка submitButton ( $content = 'Отправить', $options = [] )
$content строка

Содержимое, заключённое внутри тега кнопки. Оно НЕ будет закодировано в HTML. Поэтому вы можете передавать HTML-код, например, тег изображения. Если содержимое поступает от конечных пользователей, рекомендуется использовать encode() для предотвращения атак XSS.
$options массив

Параметры тега в виде пар имя-значение. Они будут отображены как атрибуты результирующего тега. Значения будут закодированы в HTML с помощью encode(). Если значение равно null, соответствующий атрибут не будет отображён. Подробности о том, как отображаются атрибуты, см. в renderTagAttributes().
return строка

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

submitInput() public static метод

Создаёт кнопку отправки типа input.

Будьте внимательны при именовании элементов формы, таких как кнопки отправки. Согласно документации jQuery https://api.jquery.com/submit/, существуют некоторые зарезервированные имена, которые могут вызвать конфликты, например, submit, length, или method.

public static строка submitInput ( $label = 'Отправить', $options = [] )
$label строка

Атрибут value. Если он равен null, атрибут value не будет сгенерирован.
$options массив

Параметры тега в виде пар имя-значение. Они будут отображены как атрибуты результирующего тега. Значения будут закодированы в HTML с помощью encode(). Если значение равно null, соответствующий атрибут не будет отображён. Подробности о том, как отображаются атрибуты, см. в renderTagAttributes().
return строка

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

tag() public static метод

Создаёт полный HTML-тег.

См. также:

  • beginTag()
  • endTag()
public static строка tag ( $name, $content = '', $options = [] )
$name строка|boolean|null

Имя тега. Если $name равен null или false, соответствующее содержимое будет отображено без тега.
$content строка

Содержимое, которое будет заключено между начальным и конечным тегами. Оно НЕ будет закодировано в HTML. Если содержимое поступает от конечных пользователей, рекомендуется использовать encode() для предотвращения атак XSS.
$options массив

Атрибуты HTML-тега (HTML-параметры) в виде пар имя-значение. Они будут отображены как атрибуты результирующего тега. Значения будут закодированы в HTML с помощью encode(). Если значение равно null, соответствующий атрибут не будет отображён.

Например, при использовании ['class' => 'my-class', 'target' => '_blank', 'value' => null] результат отображения HTML-атрибутов будет следующим: class="my-class" target="_blank".

Подробности о том, как отображаются атрибуты, см. в renderTagAttributes().
return строка

Сгенерированный HTML-тег

textInput() public static метод

Создаёт текстовое поле ввода.

public static string textInput ( $name, $value = null, $options = [] )
$name string

Атрибут name.
$value string

Атрибут value. Если null, атрибут value не будет сгенерирован.
$options array

Параметры тега в виде пар имя-значение. Они будут отображены в качестве атрибутов результирующего тега. Значения будут закодированы с помощью encode(). Если значение null, соответствующий атрибут не будет отображён. Подробнее о том, как отображаются атрибуты, см. renderTagAttributes().
return string

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

textarea() public static method

Создаёт текстовую область ввода.

public static string textarea ( $name, $value = '', $options = [] )
$name string

Имя поля ввода
$value string

Значение поля ввода. Обратите внимание, что оно будет закодировано с помощью encode().
$options array

Параметры тега в виде пар имя-значение. Они будут отображены в качестве атрибутов результирующего тега. Значения будут закодированы с помощью encode(). Если значение null, соответствующий атрибут не будет отображён. Подробнее о том, как отображаются атрибуты, см. renderTagAttributes(). Признаются следующие специальные параметры:

  • doubleEncode: нужно ли дважды кодировать HTML-сущности в $value. Если false, HTML-сущности в $value больше не будут кодироваться. Этот параметр доступен с версии 2.0.11.
return string

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

ul() public static method

Создаёт неупорядоченный список.

public static string ul ( $items, $options = [] )
$items array|Traversable

Элементы для создания списка. Каждый элемент создаёт одну строку списка. Обратите внимание, что элементы будут автоматически закодированы в HTML, если $options['encode'] не установлен или равен true.
$options array

Параметры (имя => конфигурация) для списка радиокнопок. Поддерживаются следующие параметры:

  • encode: boolean, нужно ли кодировать элементы в HTML. По умолчанию true. Этот параметр игнорируется, если указан параметр item.
  • separator: строка, HTML-код, разделяющий элементы. По умолчанию простая новая строка ("\n"). Этот параметр доступен с версии 2.0.7.
  • itemOptions: массив, атрибуты HTML для тегов li. Этот параметр игнорируется, если указан параметр item.

  • item: обратный вызов, который используется для создания каждого отдельного элемента списка. Подпись этого обратного вызова должна быть:

    function ($item, $index)

    где $index - ключ массива, соответствующий $item в $items. Обратный вызов должен возвращать весь тег элемента списка.

Подробнее о том, как отображаются атрибуты, см. renderTagAttributes().
return string

Сгенерированный неупорядоченный список. Если $items пустой, вернётся пустой тег списка.

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-helpers-basehtml.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API