Documentation

GetList

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

The method return list of smileys accoring to the filter. Non-static method.

Parameters

Parameter Description Available from version
arOrder Returned list sorting order, specified as an array. Array keys are fields for sorting, values are ASC/DESC meaning sorting order.
arFilter Array, specifying filter for the returned list. Array keys are field names and key values are field values.
arGroupBy Array, specifying the resulting list grouping. When parameter contains an array of field names, these fields are used for grouping. When parameter contains an empty array, the method will return the number of records, satisfying the filter. Default parameter is false - meaning do not group.
arNavStartParams Array, specifying selection range conditions for pagewise navigation.
arSelectFields Array, specifying selected fields. Contains list of fields to be returned by the method.

List of fields

ID - smiley ID,
SMILE_TYPE - smiley type,
TYPING - spelling,
IMAGE - image,
IMAGE_WIDTH - image width,
IMAGE_HEIGHT - image height,
DESCRIPTION - description.
SORT - sorting index,
LANG_LID - language (applicable when specifying filter by LANG_LID),
LANG_NAME - name (applicable when specifying filter by LANG_LID).

Returned value

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

See Also



© «Bitrix24», 2001-2024
Up