CForumGroup::GetList

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

The method GetList returns an optionally filtered and sorted list of groups.

Parameter	Description
arOrder	An array of the format Array(by1=>order1[, by2=>order2* [, ..]]), where: by - the field by which the list is to be sorted. The following values are possible: ID - the group ID; SORT* - sort index; order - sort order. The following values are possible: ASC - ascending; DESC - descending. Optional. The default value is Array("sort"=>"asc").
arFilter	An array of the format Array("filtered field"=>"filter value" [, ...]). The "filtered field" can be one of the following: ID - by the ID; SORT - sort index. The filtered field may contain one of the following filter check specifiers before the name: "!" - not equal; "<" - less than; "<=" - less or equal; ">" - more than; ">=" - more or equal. Optional. By default, records are not filtered.

Parameter

Description

arOrder

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

by - the field by which the list is to be sorted. The following values are possible:
- ID - the group ID;
- SORT - sort index;
order - sort order. The following values are possible:
- ASC - ascending;
- DESC - descending.

Optional. The default value is Array("sort"=>"asc").

arFilter

An array of the format Array("filtered field"=>"filter value" [, ...]).

The "filtered field" can be one of the following:

The filtered field may contain one of the following filter check specifiers before the name:

Optional. By default, records are not filtered.

Returns an object of the CDBResult class.