pm_cList:: setSort Method

Sets the specified sorting parameter to the instance of class pm_cList.

Syntax

function setSort ($sort)

Parameters

sort

      A string that specifies the sorting parameter (the name of any column stored in the columns_ array). The value passed in to the function via the sort parameter can also specify the sorting order – if it has the '_reverse' suffix appended to the name of the column, this means the reverse sorting order. E.g. 'name' means direct sorting order, 'name_reverse' means the reverse order (the column stored in the columns_ array will have the 'name' parameter, the suffix is never stored). Is NULL by default.

Returns

A boolean value. Always returns true after the sorting parameter is put to the instance of class pm_cList and the entire list of parameters is flushed to the database.

Remarks

If the sort parameter is not NULL, the function looks through the columns_ array, picks out the columns for which sorting is allowed, and searches the specified sorting parameter among the parameters of such columns. Once this parameter is found, it is put to the instance of class pm_cList the pm_cList::sortApplayed_ flag is disabled, after which the entire list of parameters of class pm_cList is flushed to the database.

In case the sorting parameter is not found in the columns_ array, or the sort input parameter is NULL, the value currently stored in the pm_cList::sort_default_ variable becomes a sorting parameter. Then the pm_cList::sortApplayed_ flag is disabled and all parameters are written to the database.