Bitrix Site Manager

CCatalog::GetList

CDBResult
CCatalog::GetList(
 string &by,
 string &order,
 array arFilter = Array()
);

The method GetList returns a collection of catalogs satisfying the passed filter arFilter, sorted by the parameter by in the order order.    

Parameters

ParameterDescription
by Field by which the collection entries are to be sorted. Can be one of the following:
  • SORT - sort weight (default option);
  • NAME - information block name;
  • IBLOCK_TYPE_ID - information block type ID.
order Sort order. Can be one of the following:
  • ASC - ascending (default);
  • DESC - descending.
arFilter Filter by which entries are to be sorted. The filter is an associated array with the field names as keys and the conditions as values. The following values are used:
  • ACTIVE - active state of the information block;
  • IBLOCK_TYPE_ID - information block type;
  • YANDEX_EXPORT - specifies the export to a special XML file is required (Y/N).

Return Values

Returns an instance of the class CDBResult containing a collection of arrays with the following keys.

Key Description
IBLOCK_ID Information block ID.
IBLOCK_TYPE_ID Information block type.
NAME Information block name.