Documentation

GetList

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

Returns list of blog users by the arFilter, sorted in the arOrder. Static method.

Method parameters

ParameterDescription
arOrder Array for sorting of result. The array of the array("sorting field"=>"sorting direction" [, ...]) type Field for sorting can have the following values:
  • ID - blog user ID;
  • USER_ID - site user ID;
  • ALIAS - user alias;
  • AVATAR - blog user avatar ID;
  • INTERESTS - blog user interests;
  • LAST_VISIT - time of the last blog visit;
  • DATE_REG - date of blog user registration;
  • ALLOW_POST - flag - specifies access permission to write in blogs;
  • USER_LOGIN - site user login;
  • USER_NAME - site user name;
  • USER_LAST_NAME - site user last name;
  • USER_EMAIL - site user Email;
  • GROUP_GROUP_ID - ID for a blog user group;
  • GROUP_BLOG_ID - blog ID for a blog user group.
Optional. By default, filtering is performed by descending blog user ID.
arFilter Array of the array("filtered field"=>"filter value" [, ...]) type. Filtered field can have the following values:
  • ID - blog user ID;
  • USER_ID - site user ID;
  • ALIAS - user alias;
  • AVATAR - blog user avatar ID;
  • INTERESTS - blog user interests;
  • LAST_VISIT - time of the last blog visit;
  • DATE_REG - date of blog user registration;
  • ALLOW_POST - flag - specifies access permission to write in blogs;
  • USER_LOGIN - site user login;
  • USER_NAME - site user name;
  • USER_LAST_NAME - site user last name;
  • USER_EMAIL - site user Email;
  • GROUP_GROUP_ID - ID for a blog user group;
  • GROUP_BLOG_ID - blog ID for a blog user group.
Type of filtration can be specified in front of the name of 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 filtered. 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 array will return the number of records, satisfying 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 selection parameters.
arSelectFields Array of records, which will be returned by the method. Only those fields that are needed can be specified. If there is a "*" value 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.

See Also

Examples of use

<?
// select all users -  friends за the blog with ID 1
$arOrder = Array(
        "USER_NAME" => "ASC",
        "ID" => "ASC"
    );
$arFilter = Array(
        "GROUP_BLOG_ID" => 1
    );
$arSelectedFields = Array("ID", "USER_ID", "ALIAS", "USER_LOGIN", "USER_NAME", "USER_LAST_NAME");

$dbUsers = CBlogUser::GetList(
	$arOrder,
	$arFilter,
	false,
	false
	$arSelectedFields
);
while ($arUsers = $dbUsers->Fetch())
{
    print_r($arUsers);
}
?>


© «Bitrix24», 2001-2024
Up