GetList

Описание

CDBResult CIBlockProperty::GetList(
	array arOrder = Array(),
	array arFilter = Array()
);

Возвращает список свойств по фильтру arFilter отсортированные в порядке arOrder. Метод статический.

Смотрите также

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

Параметр	Описание
arOrder	Массив для сортировки, имеющий вид by1=>order1[,by2=>order2 [, ..]], где: by - поле сортировки, может принимать значения: id - код; block_id - код информационного блока, которому принадлежит свойство; name - название; name - название; active - активность; sort - индекс сортировки; timestamp_x - дата последнего изменения searchable - по признаку участия значения свойства в поиске; filtrable - по признаку участия свойства в фильре на странице списка элементов; order - порядок сортировки, может принимать значения: asc - по возрастанию; desc - по убыванию;
arFilter	Массив вида array("фильтруемое поле"=>"значение" [, ...]). Ни один параметр фильтра не принимает массивы. Фильтруемое поле может принимать значения: ACTIVE - фильтр по активности (Y\|N); ID - по ID свойства, только число; CODE - по символьному коду (по шаблону [%_]), только строка; NAME - по названию свойства (по шаблону [%_]); EXTERNAL_ID или XML_ID - по внешнему коду(по шаблону [%_]). Возможно использование отрицания, указав !EXTERNAL_ID; PROPERTY_TYPE - по типу свойства: S - строка N - число L - список F - файл G - привязка к разделу E - привязка к элементу USER_TYPE - по пользовательскому типу свойства; UserID - Привязка к пользователю DateTime - Дата/Время EList - Привязка к элементам в виде списка FileMan - Привязка к файлу (на сервере) map_yandex - Привязка к Яndex.Карте HTML - HTML/текст map_google - Привязка к карте Google Maps ElementXmlID - Привязка к элементам по XML_ID Sequence - Счетчик EAutocomplete - Привязка к элементам с автозаполнением SKU - Привязка к товарам (SKU) video - Видео TopicID - Привязка к теме форума Кроме того, можно использовать идентификаторы пользовательских типов свойств инфоблока, добавленных сторонними модулями. SEARCHABLE - по признаку участия значения свойства в поиске (Y\|N); FILTRABLE - по признаку участия свойства в фильре на странице списка элементов (Y\|N); VERSION - по флагу хранения значений свойств элементов инфоблока; MIN_PERMISSION - фильтр по правам доступа, по умолчанию принимает R (уровень доступа Чтение); CHECK_PERMISSIONS - если установлено значение "N", то проверки прав не происходит; IBLOCK_ID - по коду информационного блока, которому принадлежит свойство (фильтр Число); IBLOCK_CODE - по символьному коду информационного блока, которому принадлежит свойство; LINK_IBLOCK_ID - по коду связанного информационного блока (может быть указан для свойств типа "E" и "G"); MULTIPLE - Проверка на множественность. по умолчанию N. Необязательное. По умолчанию записи не фильтруются.

Параметр

Описание

arOrder

Массив для сортировки, имеющий вид by1=>order1[,by2=>order2 [, ..]], где: by - поле сортировки, может принимать значения:

id - код;
block_id - код информационного блока, которому принадлежит свойство; name - название;
name - название;
active - активность;
sort - индекс сортировки;
timestamp_x - дата последнего изменения
searchable - по признаку участия значения свойства в поиске;
filtrable - по признаку участия свойства в фильре на странице списка элементов;
order - порядок сортировки, может принимать значения:
- asc - по возрастанию;
- desc - по убыванию;

arFilter

Массив вида array("фильтруемое поле"=>"значение" [, ...]). Ни один параметр фильтра не принимает массивы.

Фильтруемое поле может принимать значения:

ACTIVE - фильтр по активности (Y|N);
ID - по ID свойства, только число;
CODE - по символьному коду (по шаблону [%_]), только строка;
NAME - по названию свойства (по шаблону [%_]);
EXTERNAL_ID или XML_ID - по внешнему коду(по шаблону [%_]). Возможно использование отрицания, указав !EXTERNAL_ID;
PROPERTY_TYPE - по типу свойства:
- S - строка
- N - число
- L - список
- F - файл
- G - привязка к разделу
- E - привязка к элементу
USER_TYPE - по пользовательскому типу свойства;
- UserID - Привязка к пользователю
- DateTime - Дата/Время
- EList - Привязка к элементам в виде списка
- FileMan - Привязка к файлу (на сервере)
- map_yandex - Привязка к Яndex.Карте
- HTML - HTML/текст
- map_google - Привязка к карте Google Maps
- ElementXmlID - Привязка к элементам по XML_ID
- Sequence - Счетчик
- EAutocomplete - Привязка к элементам с автозаполнением
- SKU - Привязка к товарам (SKU)
- video - Видео
- TopicID - Привязка к теме форума
Кроме того, можно использовать идентификаторы пользовательских типов свойств инфоблока, добавленных сторонними модулями.
SEARCHABLE - по признаку участия значения свойства в поиске (Y|N);
FILTRABLE - по признаку участия свойства в фильре на странице списка элементов (Y|N);
VERSION - по флагу хранения значений свойств элементов инфоблока;
MIN_PERMISSION - фильтр по правам доступа, по умолчанию принимает R (уровень доступа Чтение);
CHECK_PERMISSIONS - если установлено значение "N", то проверки прав не происходит;
IBLOCK_ID - по коду информационного блока, которому принадлежит свойство (фильтр Число);
IBLOCK_CODE - по символьному коду информационного блока, которому принадлежит свойство;
LINK_IBLOCK_ID - по коду связанного информационного блока (может быть указан для свойств типа "E" и "G");
MULTIPLE - Проверка на множественность. по умолчанию N.

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

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

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

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

<?
$IBLOCK_ID = 11;
$properties = CIBlockProperty::GetList(Array("sort"=>"asc", "name"=>"asc"), Array("ACTIVE"=>"Y", "IBLOCK_ID"=>$IBLOCK_ID));
while ($prop_fields = $properties->GetNext())
{
	echo $prop_fields["ID"]." - ".$prop_fields["NAME"]."<br>";
}
?>

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

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

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

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

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.

Павел Адаманов 16.02.2015 18:00:40

Отфильтровать так же можно по полю IS_REQUIRED ( обязательное поле для заполнения )

Код

$idIBlock = 10;

$arFilter = array(
  'IBLOCK_ID' => $idIBlock,  
  'IS_REQUIRED' => 'Y'
);

$rsProperty = CIBlockProperty::GetList(
 array(),
 $arFilter
);

while($element = $rsProperty->Fetch())
{
  print_r($element);
}

Наверх