GetList
CDBResult
CSocNetGroupSubject::GetList(
array arOrder = array("SORT" => "ASC", "ID" => "DESC"),
array arFilter = array(),
array arGroupBy = false,
array arNavStartParams = false,
array arSelectFields = array()
);
The method returns list of subjects according to filter. Non-static method.
Parameters
| Parameter | Description | Available from version |
|---|---|---|
| arOrder | Sorting order for the returned list, specified as an array. Array keys are fields for sorting, values - ASC/DESC - sorting order. Available keys: ID, SITE_ID, NAME. | |
| arFilter | Array, specifying the filter for the returned list. Array keys are field names, values are field values. Available fields: ID, SITE_ID, NAME. | |
| arGroupBy | Array, specifying grouping of resulting list. When this parameter contains an array of field names, these names are used to arrange the list entries' grouping. When the parameter contains an empty array, the method returns the number of entries, satisfying the filter. Default parameter is false - do not group. | |
| arNavStartParams | Array, specifying the selected parameters for organizing pagewise navigation. | |
| arSelectFields | Array, specifying selected fields. Contains list of fields to be returned by the method. When the array is empty, the fields ID, SITE_ID, NAME are selected. |
List of fields
ID - subject ID,
SITE_ID - site ID,
NAME - name.
Returned value
The method returns CDBResult object, containing list of entries, satisfying the filter.
See Also
© «Bitrix24», 2001-2024