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

GetProperties

Описание

array
_CIBElement::GetProperties(
	arOrder = false, 
	arFilter = Array()
);

Метод возвращает значения свойств текущего элемента информационного блока. Нестатический метод.

Примечание: данный метод не работает, если в CIBlockElement::GetList в arSelectFields не указаны ID и IBLOCK_ID, а в arFilter не задан IBLOCK_ID. Должно быть, например, так:
$dbEl = CIBlockElement::GetList(
	Array(), 
	Array("IBLOCK_TYPE"=>"catalog", "IBLOCK_ID"=>11), 
	false, 
	false, 
	array("ID" , "IBLOCK_ID", ......)
);

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

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

ПараметрОписание
arOrder Массив вида Array(by1=>order1[, by2=>order2 [, ..]]), где by - поле для сортировки, может принимать значения:
  • id - код свойства;
  • sort - индекс сортировки;
  • name - имя свойства;
  • active - активность свойства;
  • value_id - код значения свойства;
  • enum_sort - индекс сортировки варианта списочного свойства; 
order - порядок сортировки, может принимать значения:
  • asc - по возрастанию;
  • desc - по убыванию;
arFilter Массив вида array("фильтруемое поле"=>"значения фильтра" [, ...])
"фильтруемое поле" может принимать значения:
    NAME - название свойства;
    ID - код свойства;
    ACTIVE - активность свойства (Y|N), по умолчанию выводятся только активные свойства, если необходимо вывести все значения, то установите ACTIVE в пустое значение;
    SEARCHABLE - участвует в поиске или нет (Y|N);
    PROPERTY_TYPE - тип свойства;
    CODE - символьный код свойства;
    EMPTY - пустота значения свойства (Y|N). По умолчанию выводятся все свойства и имеющие непустые значения и без значений.
Не обязательный параметр, по умолчанию равен array().

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

Метод возвращает массив значений свойств, где:
  • в качестве индексов массива "Символьный код свойства" (задается в настройках информационного блока) или, если символьный код свойства не указан, то уникальный числовой ID свойства.
  • значением массива будет массив полей свойства и дополнительно поля со значениями свойства:
    VALUE - значение свойства или массив значений свойств, если свойство множественное,
    VALUE_ENUM_ID - код варианта значения для свойства типа "Список" (массив или единичное значение),
    VALUE_XML_ID - внешний код варианта значения для свойства типа "Список" (массив или единичное значение),
    DESCRIPTION - описание значения свойства (массив или единичное значение),
    PROPERTY_VALUE_ID - код значения свойства (массив или единичное значение)

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

<?
include($_SERVER['DOCUMENT_ROOT'].'/bitrix/header.php');
if(CModule::IncludeModule('iblock'))
{
	$dbEl = CIBlockElement::GetList(Array(), Array("IBLOCK_TYPE"=>"catalog", "IBLOCK_ID"=>11));
	if($obEl = $dbEl->GetNextElement())
	{   
		$props = $obEl->GetProperties();
		echo "<pre>";
		print_r($props);
		echo "</pre>";
	}
}
?>
<?include($_SERVER['DOCUMENT_ROOT'].'/bitrix/footer.php');?>
Вывод примера:
Array
(
	[27] => Array
	(
		[ID] => 27
		[TIMESTAMP_X] => 20041222191551
		[IBLOCK_ID] => 11
		[NAME] => Battery
		[ACTIVE] => Y
		[SORT] => 500
		[CODE] => 
		[DEFAULT_VALUE] => 
		[PROPERTY_TYPE] => L
		[ROW_COUNT] => 1
		[COL_COUNT] => 30
		[LIST_TYPE] => L
		[MULTIPLE] => Y
		[XML_ID] => 
		[FILE_TYPE] => 
		[MULTIPLE_CNT] => 5
		[TMP_ID] => 
		[WITH_DESCRIPTION] => 
		[LINK_IBLOCK_ID] => 0
		[VALUE_TYPE] => text
		[VALUE_ENUM] => Li-Mon
		[VALUE] => Array
		(
			[0] => Li-Test
			[1] => Li-NEW
			[2] => Li-Mon
		)
		[~VALUE] => Array
		(
			[0] => Li-Test
			[1] => Li-NEW
			[2] => Li-Mon
		)
		[DESCRIPTION] => Array
		(
			[0] => 
			[1] => 
			[2] => 
		)
		[~DESCRIPTION] => Array
		(
			[0] => 
			[1] => 
			[2] => 
		)
		[PROPERTY_VALUE_ID] => Array
		(
			[0] => 53860
			[1] => 53861
			[2] => 53862
		)
		[VALUE_ENUM_ID] => Array
		(
			[0] => 18
			[1] => 19
			[2] => 20
		)
		[~NAME] => Battery
		[~DEFAULT_VALUE] => 
	)
	[28] => Array
        (
		[ID] => 28
		[TIMESTAMP_X] => 20041222191551
		[IBLOCK_ID] => 11
		[NAME] => Screen
		[ACTIVE] => Y
		[SORT] => 500
		[CODE] => 
		[DEFAULT_VALUE] => 
		[PROPERTY_TYPE] => S
		[ROW_COUNT] => 1
		[COL_COUNT] => 30
		[LIST_TYPE] => L
		[MULTIPLE] => Y
		[XML_ID] => 
		[FILE_TYPE] => 
		[MULTIPLE_CNT] => 5
		[TMP_ID] => 
		[WITH_DESCRIPTION] => 
		[LINK_IBLOCK_ID] => 0
		[VALUE_TYPE] => 
		[VALUE_ENUM] => 
		[VALUE] => Color
		[~VALUE] => Color
		[DESCRIPTION] => 
		[~DESCRIPTION] => 
		[PROPERTY_VALUE_ID] => 32862
		[~NAME] => Screen
		[~DEFAULT_VALUE] => 
	)
	[29] => Array
	(
		[ID] => 29
		[TIMESTAMP_X] => 20041222191551
		[IBLOCK_ID] => 11
		[NAME] => PropertyX
		[ACTIVE] => Y
		[SORT] => 500
		[CODE] => 
		[DEFAULT_VALUE] => 
		[PROPERTY_TYPE] => N
		[ROW_COUNT] => 1
		[COL_COUNT] => 30
		[LIST_TYPE] => L
		[MULTIPLE] => Y
		[XML_ID] => 
		[FILE_TYPE] => 
		[MULTIPLE_CNT] => 5
		[TMP_ID] => 
		[WITH_DESCRIPTION] => 
		[LINK_IBLOCK_ID] => 0
		[VALUE_TYPE] => 
		[VALUE_ENUM] => 
		[VALUE] => 
		[~VALUE] => 
		[DESCRIPTION] => 
		[~DESCRIPTION] => 
		[PROPERTY_VALUE_ID] => 
		[~NAME] => PropertyX
		[~DEFAULT_VALUE] => 
	)
	[FORUM_TOPIC_ID] => Array
	(
		[ID] => 383
		[TIMESTAMP_X] => 20041223132810
		[IBLOCK_ID] => 11
		[NAME] => FORUM_TOPIC_ID
		[ACTIVE] => Y
		[SORT] => 500
		[CODE] => FORUM_TOPIC_ID
		[DEFAULT_VALUE] => 
		[PROPERTY_TYPE] => N
		[ROW_COUNT] => 1
		[COL_COUNT] => 30
		[LIST_TYPE] => L
		[MULTIPLE] => N
		[XML_ID] => 
		[FILE_TYPE] => 
		[MULTIPLE_CNT] => 5
		[TMP_ID] => 
		[WITH_DESCRIPTION] => 
		[LINK_IBLOCK_ID] => 0
		[VALUE_TYPE] => 
		[VALUE_ENUM] => 
		[VALUE] => 
		[~VALUE] => 
		[DESCRIPTION] => 
		[~DESCRIPTION] => 
		[PROPERTY_VALUE_ID] => 
		[~NAME] => FORUM_TOPIC_ID
		[~DEFAULT_VALUE] => 
	)
	[386] => Array
	(
		[ID] => 386
		[TIMESTAMP_X] => 20050119162457
		[IBLOCK_ID] => 11
		[NAME] => Photo
		[ACTIVE] => Y
		[SORT] => 500
		[CODE] => 
		[DEFAULT_VALUE] => 
		[PROPERTY_TYPE] => F
		[ROW_COUNT] => 1
		[COL_COUNT] => 30
		[LIST_TYPE] => L
		[MULTIPLE] => N
		[XML_ID] => 
		[FILE_TYPE] => 
		[MULTIPLE_CNT] => 5
		[TMP_ID] => 
		[WITH_DESCRIPTION] => Y
		[LINK_IBLOCK_ID] => 0
		[VALUE_TYPE] => text
		[VALUE_ENUM] => 
		[VALUE] => 2309
		[~VALUE] => 2309
		[DESCRIPTION] => HP
		[~DESCRIPTION] => HP 
		[PROPERTY_VALUE_ID] => 53863
		[~NAME] => Photo
		[~DEFAULT_VALUE] => 
	)
)


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

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

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

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

Также Пользовательские комментарии не являются местом для обсуждения функционала. По подобным вопросам обращайтесь на форумы.
1
idalgo
Сообщение не промодерировано, возможны ошибки и неточности.
Действительно, в документации не верно описана работа фильтра. До сих пор не работает фильтр по массиву для символьного кода свойства CODE, например:
Код
$props = $obEl->GetProperties(false, ['CODE' => ['CODE_1', 'CODE_2']]);

Вызывает ошибку:
Код
mysqli::real_escape_string(): Argument #1 ($string) must be of type string, array given

Приходится доставать абсолютно все свойства элемента, что печально.
2
Роман Морозов
Сообщение не промодерировано, возможны ошибки и неточности.
Цитата
Sumato Shigoto пишет:
В $arFilter['PROPERTY_TYPE'] можно передать только одно значение. Если передать массив, то вернутся все типы свойств без разбора.

Вот так:  [CODE] GetProperties( $arOrder , Array ( "PROPERTY_TYPE"  = >  "F" ))  [/CODE]  вернутся только свойства типа "F".

А вот так:  [CODE] GetProperties( $arOrder , Array ( "PROPERTY_TYPE"  = >  Array ( "N" , "S" )))  [/CODE] вернутся все типы свойств.  
Фильтр тут вообще не поддерживает массивы. По коду свойства та же проблема, либо 1 код указывать и 1 свойство получать, либо вообще все.
3
Sumato Shigoto
В $arFilter['PROPERTY_TYPE'] можно передать только одно значение. Если передать массив, то вернутся все типы свойств без разбора.

Вот так:
Код
GetProperties($arOrder,Array("PROPERTY_TYPE" = > "F")) 
вернутся только свойства типа "F".

А вот так:
Код
GetProperties($arOrder,Array("PROPERTY_TYPE" = > Array("N","S"))) 
вернутся все типы свойств.  
© «Битрикс», 2001-2024, «1С-Битрикс», 2024
Наверх