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

GetList

CUserTypeEntity::GetList
 (
   Sort=array(),
   Filter=array()
 )

Метод возвращает список пользовательских полей по фильтру $arFilter с сортировкой $arOrder. Статический метод.

Параметры

Параметр Описание
arOrderМассив полей для сортировки, содержащий пары поле сортировки => направление сортировки. Поля сортировки:
  • ID - ID пользовательского поля
  • ENTITY_ID - название объекта, которому принадлежит пользовательское поле.
  • FIELD_NAME - название поля;
  • USER_TYPE_ID
  • XML_ID
  • SORT - значение сортировки;
Направление сортировки:
  • ASC - по возрастанию;
  • DESC - по убыванию.
arFilter Массив вида array("фильтруемое поле" => "значение" [, ...]). Может принимать значения:
  • ID - ID пользовательского поля;
  • ENTITY_ID - название объекта, которому принадлежит пользовательское поле.
    Напр: "ENTITY_ID" => "IBLOCK_".$iblock_id."_SECTION";
  • FIELD_NAME - Название поля;
  • SORT - Значение сортировки;
  • USER_TYPE_ID
  • XML_ID
  • MULTIPLE - Множественность свойства;
  • MANDATORY
  • SHOW_FILTER
  • SHOW_IN_LIST
  • EDIT_IN_LIST
  • IS_SEARCHABLE
  • LANG - ID языка

    Внимание! При не указание в фильтре ключа LANG со значением необходимого языка ('LANG' => 'ru'), поля "Подпись в форме редактирования", "Заголовок в списке" и т.д. не будут участвовать в выборке. ([EDIT_FORM_LABEL], [LIST_COLUMN_LABEL], [LIST_FILTER_LABEL], [ERROR_MESSAGE], [HELP_MESSAGE])

Необязательное. По умолчанию записи не фильтруются.

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

Возвращается объект CDBResult.

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

<?
$rsData = CUserTypeEntity::GetList( array($by=>$order), array() );
while($arRes = $rsData->Fetch())
{
echo $arRes["FIELD_NAME"]."
"; // вывод названия пользовательского поля echo "<pre>"; print_r($arRes); echo "</pre>"; // вывод массива значений } ?>


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

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

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

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

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
1
Bazilio
Класс CUserTypeEntity расширяет класс CAllUserTypeEntity.
Класс CAllUserTypeEntity и его методы очень хорошо документированы в файле с этим классом:
/bitrix/modules/main/classes/general/usertype.php

Для создания/изменения свойств программным путём нужно формировать правильный параметр SETTINGS. Формат этого параметра для каждого типа свойств можно представить изучив методы PrepareSettings в классах, описывающих типы свойств (usertypefile.php, usertypeint.php, usertypeelement.php и т.д.).
1
Julliet
Если нужно поменять какие-то свойства пользовательского поля, есть метод Upd ate($ID, $arFields)

Пример - поменяем значение поля по умолчанию:


Код
$arSettings["DEFAULT_VALUE"] = 100;
$arFields = array(
  
"SE TTINGS" => $arSettings
);

$entity = new CUserTypeEntity;

if($obg = $entity->Update($ID, $arFields)) {

echo 'обновлено';

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