CFilterUnquotableWords::GetList
CDBResult
GetList(
[array arOrder [,
array arFilter [,
bool bCount ]]]
);
The GetList method returns a selection of records filtered by arFilter and sorted in the
arOrder order.
Parameters
Parameter | Description |
arOrder |
An array of the format Array(by1=>order1[, by2=>order2 [, ..]]),
where:
- by - field by which the selection is to be sorted ; can have the following values:
- ID - the message ID;
- WORDS - a word;
- PATTERN - a pattern which would match words under this dictionary record;
- REPLACEMENT - a word with which the matching words will be replaced;
- DESCRIPTION - the description;
- USE_IT - use this pattern in filter;
- 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;
- DICTIONARY_ID - the dictionary ID;
- WORDS - a word;
- PATTERN - a pattern which would match
- words under this dictionary record;
- REPLACEMENT - a word with which the
- matching words will be replaced;
- DESCRIPTION - the description;
- USE_IT - use this pattern in filter;
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 the number of messages that
match the filter. Optional. False by default.
|
Return Values
The method returns an instance of the CDBResult object.
See Also
CDBResult
Dictionary table
Letter dictionary table
Word dictionary table