Bitrix Site Manager

CForumPMFolder::GetList

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

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

Parameters

ParameterDescription
arOrder An array of the format Array(by1=>order1[, by2=>order2 [, ..]]), where:
  • by - filter field, can have the following values:
    • ID - the message ID;
    • USER_ID - the folder owner user ID;
    • TITLE - the name of a user folder;
  • 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 message ID;
  • USER_ID - the folder owner user ID;
  • TITLE - the name of a user folder.

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 messages matching the filter. Optional. False by default.

Return Values

The method returns an instance of the CDBResult object.

See Also

CDBResult
User folder table