Documentation

GetList

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

Returns list of paths by the arFilter, sorted by the arOrder. Non-static.

Method parameters

ParameterDescription
arOrder Array for sorting of results. Array of the array("sorting field"=>"sorting direction" [, ...]) type Field for sorting can have the following values:
  • ID - path ID;
  • SITE_ID - site ID;
  • PATH - path.
Optional. By default it is filtered by descension of the category identifier.
arFilter Array of the array("filtered field"=>"filter value" [, ...]) type. Filtered field can have the following values:
  • ID - path ID;
  • SITE_ID - site ID;
  • PATH - path.
Filtering can be performed by types as well. The following types exist:
  • B - user blog,
  • P - user post,
  • U - just user,
  • G - group blog,
  • H - group post
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 of 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.

Examples of use

<?
// select all path sites with the "com" identifier 
$arOrder = Array(
        "PATH" => "ASC",
        "ID" => "ASC"
    );
$arFilter = Array(
        "SITE_ID"=>'ru'
    );
$arSelectedFields = Array("ID", "SITE_ID", "PATH");

$dbSitePath = CBlogSitePath::GetList($arOrder, $arFilter, false, false, $arSelectedFields);
while ($arSitePath = $dbSitePath->Fetch())
{
    print_r($arSitePath);
}
?>


© «Bitrix24», 2001-2024
Up