Structures_DataGrid::setDefaultSort()

Structures_DataGrid::setDefaultSort()  -- Set default sorting specification

Referentiesamenvatting

require_once 'Structures/DataGrid.php';

mixed Structures_DataGrid::setDefaultSort (array $sortSpec)

Beschrijving

If there is no sorting query in the HTTP request, and if the sortRecordSet() method is not called, then the specification passed to setDefaultSort() will be used.

This is especially useful if you want the data to already be sorted when a user first see the datagrid.

Parameter

array $sortSpec

Sorting specification Structure: array(fieldName => direction, ...)

Return waarde

returns Either true or a PEAR_Error object

Throws

throws no exceptions thrown

Note

Deze functie kan niet statisch worden aangeroepen.