Documentation

GetList

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

The method selects list of additional features according to filter. Static method.

Parameters

Parameter Description Available from version
arOrder Sorting order of returned list. It is set as array. Keys for this array are fields for sorting and values - are the sorting order. Permissible keys: ID, ENTITY_TYPE, ENTITY_ID, FEATURE, FEATURE_NAME, ACTIVE, DATE_CREATE, DATE_UPDATE.
arFilter Array, specifying the filter for the returned list. Array keys are field name and values - are their values accordingly. Permissible fields: ID, ENTITY_TYPE, ENTITY_ID, FEATURE, FEATURE_NAME, ACTIVE, DATE_CREATE, DATE_UPDATE.
arGroupBy Array, specifying the grouping of resulting list. When parameter contains an array of field names, grouping is performed by these fields. When the parameter contains an empty array, the method returns the number of records that satisfy the filter. The parameter equals false by default: grouping disabled.
arNavStartParams Array, specifying selection criteria for arranging pagewise navigation.
arSelectFields Array, specifying selected fields. Contains list of fields that must be returned by the method. When the array is empty, the fields ID, ENTITY_TYPE, ENTITY_ID, FEATURE, FEATURE_NAME, ACTIVE, DATE_CREATE, DATE_UPDATE are selected. Any fields from the fields list are permissible in the array.

List of fields

ID - record ID,
ENTITY_TYPE - object type: SONET_ENTITY_GROUP - group, SONET_ENTITY_USER - user,
ENTITY_ID - object ID (group or user),
FEATURE - internal name for additional features,
FEATURE_NAME - name for additional features,
ACTIVE - active status flag (Y/N),
DATE_CREATE - date when record is created,
DATE_UPDATE - date when record is modified,
GROUP_NAME - group name.

Returned value

The method returns the CDBResult object type, containing records, satisfying condition of the selection.

See Also

  • [link=89808]CDBResult[/link]

Example

<?
// Get all additional features of the group with $ID into an array.
$arFeaturesTmp = array(); 
$dbResultTmp = CSocNetFeatures::GetList( 
   array(), 
   array("ENTITY_ID" => $ID, "ENTITY_TYPE" => SONET_ENTITY_GROUP) 
); 
while ($arResultTmp = $dbResultTmp->GetNext()) 
   $arFeaturesTmp[$arResultTmp["FEATURE"]] = $arResultTmp; 
?>


© «Bitrix24», 2001-2024
Up