Trait rootlocal\widgets\sortable\SortableGridQueryTrait

All Classes | Properties | Methods

Trait SortableGridQueryTrait

Trait for Sortable Grid Query class Model

Example:

Query class:

     class BookQuery extends ActiveQuery
     {
         use SortableGridQueryTrait;
         // ...
      }

Model class:

     class Book extends ActiveRecord
     {
         // ...
         public static function find(): BookQuery
         {
             return new BookQuery(get_called_class());
         }
         // ...
     }

Sorting:

     $query = Book::find()->sortByOrder();

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$modelClass	\yii\db\ActiveRecord		rootlocal\widgets\sortable\SortableGridQueryTrait

Public Methods

Hide inherited methods

Method	Description	Defined By
sortByOrder()	Order Sorting by 'sortableAttribute' rootlocal\widgets\sortable\SortableGridBehaviorInterface::getSortableAttribute()	rootlocal\widgets\sortable\SortableGridQueryTrait

Property Details

Hide inherited properties

$modelClass public property

public \yii\db\ActiveRecord $modelClass = null

Method Details

Hide inherited methods

sortByOrder() public method

Order Sorting by 'sortableAttribute' rootlocal\widgets\sortable\SortableGridBehaviorInterface::getSortableAttribute()

public \yii\db\ActiveQuery sortByOrder ( )

Source code

                public function sortByOrder(): ActiveQuery
{
    $modelClass = $this->modelClass;
    /* @var $model SortableGridBehaviorInterface|ActiveRecordInterface */
    $model = $modelClass::instance();
    return $this->orderBy([$model::tableName() . '.' . $model->getSortableAttribute() => SORT_ASC]);
}