GetList

CDBResult
CSearchStatistic::GetList(
	array arOrder = false,
	array arFilter = false,
	array arSelect = false,
	array bGroup = false
);

The method returns list of search phrases. Static method.

Method parameters

Parameter	Description
arOrder	Array, containing the sorting attribute as the "field name"=>"direction". Field name can have the values of any field names of a search statistics object. Optional parameter. Value by default - false - means that the result will not be sorted.
arSelect	Array, containing fields for selection. Only the necessary fields can be specified. Optional parameter. Value by default - false - means that all fields of the request main table will be returned.
arFilter	Array, containing filter as the "field name"=>"filter value" sets. Field name can have the values of the name of any of the fields of a search statistics object. Optional parameter. Value by default - false - means that the result will not be filtered.
bGroup	Array of fields by which the search phrases are grouped. The array has the following structure: array("field_name1", "field_name2", . . .) Any field of search statistics object can be specified as the "field_nameN". Optional parameter. If the array is empty, the method will return the number of records, satisfying the filter. If bGroup = true the COUNT can be passed to the arOrder to perform sorting by the count number. Value by default - false - means that the result will not be grouped.

Returned values

The result of the CDBResult request type is returned. Fields that are listed in the arSelect parameters will become available when retrieving the result via CDBResult class methods.