GetList

CDBResult
CBlogCandidate::GetList(
 array arOrder = Array("ID"=>"DESC"),
 array arFilter = Array(),
 bool  arGroupBy = false,
 bool  arNavStartParams = false,
 array arSelectFields = Array()
);

Returns list of users that wish to join the blog friends, via the arFilter, sorted in the arOrder. Non-static method.

Method parameters

Parameter	Description
arOrder	An array for sorting of result. Array of the array("sorting field"=>"sorting direction" [, ...]) type Field for sorting can have the following values: ID - record ID; BLOG_ID - blog ID; USER_ID - user ID; BLOG_USER_ID - blog user ID; BLOG_USER_ALIAS - blog user alias; USER_LOGIN - user login; USER_NAME - user name; USER_LAST_NAME - user last name; USER_EMAIL - user email. Optional. By default, it is filtered by descension of record ID.
arFilter	Array of the array("filtered field"=>"filter value" [, ...]) type. FIltered field can have the following values: ID - record ID; BLOG_ID - blog ID; USER_ID - user ID; BLOG_USER_ID - blog user ID; BLOG_USER_ALIAS - blog user alias; USER_LOGIN - user login; USER_NAME - user name; USER_LAST_NAME - user lat name; USER_EMAIL - user email. Type of filtration can be specified in front of the filtered field: "!" - not equal "<" - less "<=" - less or equal ">" - more ">=" - more or equal "filter values" - single value or an array. Optional. By default, records are not filtered.
arGroupBy	Array of fields, by which the records are grouped. The array has the following structure: array("field_name1", "aggregate_function2" => "field_name2", ...) Any field can be specified as "field_nameN". The following can be specified as aggregate function: COUNT - number count; AVG - average value calculation; MIN - minimal value calculation; MAX - maximum value calculation; SUM - sum calculation. If the array is empty, the method will return the number of records that satisfy the filter. Optional. By default - false - means that the result will not be grouped.
arNavStartParams	Array of selection parameters. Can contain the following keys: "nTopCount" - number of records returned by the method will be limited from above by the value of this key any key, accepted by the CDBResult::NavQuery method as the third parameter. Optional. By default - false - means that there are no sample parameters.
arSelectFields	Array of record fields, which will be returned by the method. Only those fields that are needed can be specified. If there is a "*" value present in the array - all available fields will be returned. Optional. By default - empty array() - means that all fields of the request's main table will be returned.

Returned value

CDBResult object is returned.

Examples of use

<?
// select the list of candidates to joint the blog friends
//with ID 1
$dbUsers = CBlogCandidate::GetList(
    array("USER_LAST_NAME" => "ASC", "USER_NAME" => "ASC"),
    array("BLOG_ID" => 1),
    false,
    false,
    array("ID", "USER_ID", "BLOG_USER_ALIAS", "USER_LOGIN", "USER_NAME", "USER_LAST_NAME")
);
while ($arUsers = $dbUsers->Fetch())
{
    print_r($arUsers);
}
?>