Documentation

GetList

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

Returns list of blog user groups by thearFilter, sorted by the arOrder. Non-static method.

Method parameters

ParameterDescription
arOrder Array for sorting of the result. Array of the array("sorting field"=>"sorting direction" [, ...]) type Sorting field can have the following values:
  • ID - user group ID;
  • NAME - user group name;
  • BLOG_ID - blog ID;
  • USER2GROUP_ID - attachment ID for user, included into the user group;
  • USER2GROUP_USER_ID - ID of the user, included into the blog user group.
Optional. By default, filtering is performed by descension of the user group ID.
arFilter Array of the array("filtered field"=>"filter value" [, ...]). Filtered field can have the following values:
  • ID - user group ID;
  • NAME - user group ID;
  • BLOG_ID - blog ID;
  • USER2GROUP_ID - attachment ID for user, included into the user group;
  • USER2GROUP_USER_ID - ID of the user, included into the 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 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
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.

See Also

Examples of use

<?
// select all user groups of the blog with ID = 1

$SORT = Array("NAME" => "ASC", "ID" => "ASC");
$arFilter = Array(
	"BLOG_ID" => 1
    );	

$dbUserGroup = CBlogUserGroup::GetList(
        $SORT,
        $arFilter
    );

while ($arUserGroup = $dbUserGroup->Fetch())
{
    print_r($arUserGroup);
}
?>


© «Bitrix24», 2001-2024
Up