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

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-2024, «1С-Битрикс», 2024