CDBResult
GetList(
[array arOrder [,
array arFilter]]
);
Returns an optionally sorted and filtered list of subscriptions.
Parameters
| Parameter | Description |
| arOrder |
An array in the format Array(by1=>order1[, by2=>order2 [, ..]]),
where:
- by - name of the field by which the sorting is to be performed:
- ID - the subscription ID;
- USER_ID - the subscriber ID;
- FORUM_ID - the forum ID;
- TOPIC_ID - the topic ID;
- START_DATE - the date of subscription;
- order - sort order:
- ASC - ascending;
- DESC - descending;
Optional. By default Array("ID"=>"ASC").
|
| arFilter |
An array in the format array("filter
field"=>"condition value" [, ...]). The following keys are
possible:
- ID - the subscription ID;
- USER_ID - the subscriber ID;
- FORUM_ID - the forum ID;
- TOPIC_ID - the topic ID;
- TOPIC_ID_OR_NULL - the topic ID or NULL (checks if equal only);
- LAST_SEND - the ID of the last sent message;
- LAST_SEND_OR_NULL - the ID of the last sent message or NULL (checks
if less only).
The filter field may be prepended with the condition operator:
"!" (not equal), "<", "<=",
">", ">=".
Optional. By default, the
records are not filtered.
|
Return Values
Returns an instance of the
CDBResult.
See Also
CDBResult
Subscription
fields