CSort

Property Details

list of attributes that are allowed to be sorted. For example, array('user_id','create_time') would specify that only 'user_id' and 'create_time' of the model modelClass can be sorted. By default, this property is an empty array, which means all attributes in modelClass are allowed to be sorted.

This property can also be used to specify complex sorting. To do so, a virtual attribute can be declared in terms of a key-value pair in the array. The key refers to the name of the virtual attribute that may appear in the sort request, while the value specifies the definition of the virtual attribute.

In the simple case, a key-value pair can be like 'user'=>'user_id' where 'user' is the name of the virtual attribute while 'user_id' means the virtual attribute is the 'user_id' attribute in the modelClass.

A more flexible way is to specify the key-value pair as

'user'=>array(
    'asc'=>'first_name, last_name',
    'desc'=>'first_name DESC, last_name DESC',
    'label'=>'Name'
)

'price'=>array(
    'asc'=>'item.price',
    'desc'=>'item.price DESC',
    'label'=>'Item Price'
)

'price'=>array(
    'asc'=>'item.price',
    'desc'=>'item.price DESC',
    'label'=>'Item Price',
    'default'=>'desc',
)

'attributes'=>array(
    'price'=>array(
        'asc'=>'item.price',
        'desc'=>'item.price DESC',
        'label'=>'Item Price',
        'default'=>'desc',
    ),
    '*',
)

the default order that should be applied to the query criteria when the current request does not specify any sort. For example, 'create_time DESC', or 'name, create_time DESC'.

Starting from version 1.1.3, you can also specify the default order using an array, where the array keys are virtual attribute names as declared in attributes, and the array values indicate whether the sorting of the corresponding attributes should be in descending order. For example,

'defaultOrder'=>array(
    'price'=>true,
)

the tag appeared in the GET parameter that indicates the attribute should be sorted in descending order. Defaults to 'desc'.

Returns the currently requested sort information.

the name of the model class whose attributes can be sorted. The model class must be a child class of CActiveRecord.

whether the sorting can be applied to multiple attributes simultaneously. Defaults to false, which means each time the data can only be sorted by one attribute.

the order-by columns represented by this sort object. This can be put in the ORDER BY clause of a SQL statement.

the additional GET parameters (name=>value) that should be used when generating sort URLs. Defaults to null, meaning using the currently available GET parameters.

the route (controller ID and action ID) for generating the sorted contents. Defaults to empty string, meaning using the currently requested route.

separators used in the generated URL. This must be an array consisting of two elements. The first element specifies the character separating different attributes, while the second element specifies the character separating attribute name and the corresponding sort direction. Defaults to array('-','.').

the name of the GET parameter that specifies which attributes to be sorted in which direction. Defaults to 'sort'.

Method Details

Constructor.

Modifies the query criteria by changing its CDbCriteria::order property. This method will use directions to determine which columns need to be sorted. They will be put in the ORDER BY clause. If the criteria already has non-empty CDbCriteria::order value, the new value will be appended to it.

Creates a hyperlink based on the given label and URL. You may override this method to customize the link generation.

Creates a URL that can lead to generating sorted data.

Returns the sort direction of the specified attribute in the current request.

Returns the currently requested sort information.

Generates a hyperlink that can be clicked to cause sorting.

Returns the real definition of an attribute given its name.

The resolution is based on attributes and CActiveRecord::attributeNames.

• When attributes is an empty array, if the name refers to an attribute of modelClass, then the name is returned back.
• When attributes is not empty, if the name refers to an attribute declared in attributes, then the corresponding virtual attribute definition is returned. Starting from version 1.1.3, if attributes contains a star ('*') element, the name will also be used to match against all model attributes.
• In all other cases, false is returned, meaning the name does not refer to a valid attribute.

Resolves the attribute label for the specified attribute. This will invoke CActiveRecord::getAttributeLabel to determine what label to use. If the attribute refers to a virtual attribute declared in attributes, then the label given in the attributes will be returned instead.

Total 2 comments:

$pages=new CPagination($model->proxyCount);
$pages->pageSize=self::PAGE_SIZE;

$sort=new CSort('Model');
$order = array();
foreach ($sort->getDirections() as $field => $direction)
{
    $field = '??.'.$field;
    if ($direction)
        $order[] = $field.' ASC';
    else
        $order[] = $field.' DESC';
}

$models = $model->models(array('order'=>implode(',', $order), 'limit'=>$pages->getPageSize(), 'offset'=>$pages->getPageSize()*$pages->getCurrentPage()));

Your Comment: