Documentation

GetList

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

The method returns list of access permissions. Static method.

Parameters

Parameter Description Available from version
arOrder Sorting order for the returned list, defined as array. Array keys are sorting fields, values - ASC/DESC - sorting order. Available keys: ID, FEATURE_ID, OPERATION_ID, ROLE, FEATURE_ENTITY_TYPE, FEATURE_ENTITY_ID, FEATURE_FEATURE, FEATURE_FEATURE_NAME, FEATURE_ACTIVE.
arFilter Array, specifying filter for the returned list. Array keys are field name and values - are field values. Available fields:ID, FEATURE_ID, OPERATION_ID, ROLE, FEATURE_ENTITY_TYPE, FEATURE_ENTITY_ID, FEATURE_FEATURE, FEATURE_FEATURE_NAME, FEATURE_ACTIVE.
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 field. Contain list of fields to be returned by the method. When the array is empty, the following fields are selected: ID, FEATURE_ID, OPERATION_ID, ROLE. Array can contain any fields from the fields list.

List of fields

ID - record ID,
FEATURE_ID - extra features ID,
OPERATION_ID - operation ID,
ROLE - role,
FEATURE_ENTITY_TYPE - object type: SONET_ENTITY_GROUP - group, SONET_ENTITY_USER - user,
FEATURE_ENTITY_ID - object ID (group or users),
FEATURE_FEATURE - internal extra features name,
FEATURE_FEATURE_NAME - extra features name,
FEATURE_ACTIVE - active status flag (Y/N).

Returned value

The method returns CDBResult object, containing entries, satisfying selected returned parameters.

See Also



© «Bitrix24», 2001-2024
Up