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

GetList

CDBResult CUserFieldEnum::GetList(
 array aSort = array(),
array aFilter = array()
)

Возвращает значения списка пользовательского поля в виде объекта класса CDBResult. Для параметра aSort по умолчанию является сортировка по полю SORT, а затем по полю ID по возрастанию. Нестатический метод.

Параметры

ПараметрОписание
aSortМассив для сортировки значений. В массиве допустимы следующие ключи:
  • ID - ID значения списка;
  • USER_FIELD_ID - идентификатор пользовательского поля;
  • VALUE - значение для отображения;
  • DEF - флаг умолчания;
  • SORT - сортировка;
  • XML_ID - код внешнего источника.
Значения ключей могут принимать значения:
  • ASC - по возрастанию
  • DESC - по убыванию
aFilterМассив для фильтрации значений. В массиве допустимы следующие ключи:
  • ID - ID значения списка;
  • USER_FIELD_ID - идентификатор пользовательского поля;
  • VALUE - значение для отображения;
  • DEF - флаг умолчания;
  • SORT - сортировка;
  • XML_ID - код внешнего источника.
Значения ключей задают точное соответствие для фильтрации.

См. также

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

<?
//Пусть для пользователей определено пользовательское свойство
// типа список с кодом UF_GENDER. Выведем отображаемое значение для
// текущего пользователя.

//Сначала получим значение пользовательского поля:
global $USER;
if(is_object($USER))
{
$rsUser = CUser::GetList($by, $order,
array(
"ID" => $USER->GetID(),
),
array(
"SELECT" => array(
"UF_GENDER",
),
)
);
if($arUser = $rsUser->Fetch())
{
$rsGender = CUserFieldEnum::GetList(array(), array(
"ID" => $arUser["UF_GENDER"],
));
if($arGender = $rsGender->GetNext())
echo $arGender["VALUE"];
}
}
?>

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

$obEnum = new \CUserFieldEnum;
        $rsEnum = $obEnum->GetList(array(), array("USER_FIELD_ID" => $arUserField["ID"]));

        $enum = array();
        while($arEnum = $rsEnum->Fetch())
        {
            $enum[$arEnum["ID"]] = $arEnum["VALUE"];
        }


© «Битрикс», 2001-2018, «1С-Битрикс», 2018
Наверх