GetList

CDBResult
GetList(
 [array arOrder [,
 array arFilter [,
 bool bCount ]]]
);

The GetList method returns a selection of folders filtered by arFilter and sorted in the arOrder order.

Parameter	Description
arOrder	An array of the format Array(by1=>order1[, by2=>order2 [, ..]]), where: by - filter field, can have the following values: ID - the record ID; TITLE - the name of the dictionary; TYPE - the dictionary type; order - sort order, can have the following values: ASC - ascending; DESC - descending; Optional. The default value is Array("ID"=>"ASC").
arFilter	An array in the format array("filtered field"=>"filter value" [, ...]). The following values are possible: ID - the record ID; TITLE - the name of the dictionary; TYPE - the dictionary type. The following logic can be specified at the beginning of the field name: "!" - not equal; "<" - less than; "<=" - less or equal; ">" - more than; ">=" - more or equal. Required.
bCount	If set to true, the method returns a number of records matching with the filter. Optional. False by default.

Parameter

Description

arOrder

An array of the format Array(by1=>order1[, by2=>order2 [, ..]]), where:

by - filter field, can have the following values:
- ID - the record ID;
- TITLE - the name of the dictionary;
- TYPE - the dictionary type;
order - sort order, can have the following values:
- ASC - ascending;
- DESC - descending;

Optional. The default value is Array("ID"=>"ASC").

arFilter

An array in the format array("filtered field"=>"filter value" [, ...]). The following values are possible:

The following logic can be specified at the beginning of the field name:

Required.

bCount

If set to true, the method returns a number of records matching with the filter. Optional. False by default.

The method returns an instance of the CDBResult object.

CFilterDictionary::GetList