Документация для разработчиков

GetSettingsHTML

string
CIBlockProperty*::GetSettingsHTML(
array arProperty,
array strHTMLControlName,
array &arPropertyFields
);

Метод должна вернуть безопасный HTML отображения настроек свойства для формы редактирования инфоблока. Метод статический при использовании штатных свойств. У свойств, созданных клиентом, обязан быть статическим при использовании php7.

Примечание: вызывается при построении формы редактирования инфоблока.

Параметры вызова

Параметр Описание
arProperty Метаданные свойства. См. Свойства элементов инфоблока
strHTMLControlNameИмя элемента управления для заполнения настроек свойства. Массив вида:
array(
"NAME" => html безопасное имя для настроек,
);
arPropertyFieldsПустой массив.

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

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

В параметре arPropertyFields можно вернуть дополнительные флаги управления формой:
  • HIDE - массив названий полей свойства которые будут скрыты для редактирования. Возможные значения: MULTIPLE, SEARCHABLE, FILTRABLE, WITH_DESCRIPTION, MULTIPLE_CNT, ROW_COUNT, COL_COUNT и DEFAULT_VALUE.
  • SHOW - массив полей которые должны быть показаны даже если базовое свойство их не поддерживает. Возможные значения: MULTIPLE, SEARCHABLE, FILTRABLE, WITH_DESCRIPTION, MULTIPLE_CNT, ROW_COUNT и COL_COUNT.
  • SET - ассоциативный массив полей для принудительного выставления значений в случае если они не отображаются в форме. Возможные значения: MULTIPLE, SEARCHABLE, FILTRABLE, WITH_DESCRIPTION, MULTIPLE_CNT, ROW_COUNT и COL_COUNT.
  • USER_TYPE_SETTINGS_TITLE - строка для отображения в качестве заголовка секции настроек.

См. также

Примеры использования

<?
class CIBlockPropertyMyDateTime
{
function GetSettingsHTML($arProperty, $strHTMLControlName, &$arPropertyFields)
{
$arPropertyFields = array(
"HIDE" => array("FILTRABLE", "ROW_COUNT", "COL_COUNT", "DEFAULT_VALUE"), //will hide the field
"SET" => array("FILTRABLE" => "N"), //if set then hidden field will get this value
"USER_TYPE_SETTINGS_TITLE" => "Настройки даты/времени"
);

return '<tr>
<td>Длина поля ввода:</td>
<td><input type="text" size="5" name="'.$strHTMLControlName["NAME"].'[WIDTH]"></td>
</tr>';
}
}
?>


Пользовательские комментарии

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

Для этого нужно всего лишь авторизоваться на сайте

Но помните, что Пользовательские комментарии, несмотря на модерацию, не являются официальной документацией. Ответственность за их использование несет сам пользователь.

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
© «Битрикс», 2001-2019, «1С-Битрикс», 2019
Наверх