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

GetUserTypeDescription

array
CIBlockProperty*::GetUserTypeDescription( );

Метод возвращает массив описывающий поведение пользовательского свойства. Вызывается по событию OnIBlockPropertyBuildList. Метод статический при использовании штатных свойств. У свойств, созданных клиентом, обязан быть статическим при использовании php7.

Структура массива

ПолеОписание
PROPERTY_TYPE
Обязательное. Указывает модулю какое свойство будет базовым для хранения значений пользовательского свойства, а также для фильтрации и некоторых других действий. Возможные значения:
  • S - строка
  • N - число с плавающей точкой
  • L - список значений
  • F - файл
  • G - привязка к разделам
  • E - привязка к элементам
USER_TYPEОбязательное. Уникальный идентификатор пользовательского свойства.
DESCRIPTIONОбязательное. Краткое описание. Будет выведено в списке выбора типа свойства при редактировании информационного блока.
CheckFieldsНе обязательное. Значением этого поля должен быть массив из двух элементов. В первом должно быть название класса, а во втором название метода который будет вызван при наступлении соответствующего события.
GetLengthАналогично.
ConvertToDBАналогично.
ConvertFromDBАналогично.
GetPropertyFieldHtmlАналогично.
GetPropertyFieldHtmlMultyНеобязательный обработчик. Является аналогом GetPropertyFieldHtml за исключением того, что в value приходят несколько значений..
GetAdminListViewHTMLАналогично.
GetPublicViewHTMLАналогично.
GetPublicEditHTMLАналогично.
GetSettingsHTMLАналогично.
PrepareSettingsАналогично.

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

Отсутствуют.

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

Массив.

См. также

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

<?
class CIBlockPropertyMyDateTime
{
public static function GetUserTypeDescription()
{
return array(
"PROPERTY_TYPE" =>"S",
"USER_TYPE" =>"MyDateTime",
"DESCRIPTION" =>"Дата/Время",
//optional handlers
"CheckFields" =>array("CIBlockPropertyMyDateTime","CheckFields"),
"GetLength" =>array("CIBlockPropertyMyDateTime","GetLength"),
"ConvertToDB" =>array("CIBlockPropertyMyDateTime","ConvertToDB"),
"ConvertFromDB" =>array("CIBlockPropertyMyDateTime","ConvertFromDB"),
"GetPropertyFieldHtml" =>array("CIBlockPropertyMyDateTime","GetPropertyFieldHtml"),
"GetAdminListViewHTML" =>array("CIBlockPropertyMyDateTime","GetAdminListViewHTML"),
"GetPublicViewHTML" =>array("CIBlockPropertyMyDateTime","GetPublicViewHTML"),
"GetPublicEditHTML" =>array("CIBlockPropertyMyDateTime","GetPublicEditHTML"),
);
}
}
?>


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

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

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

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

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