paulzi/yii2-sortable

Sortable Behavior for Yii2

Yii2 Sortable Behavior

It implements the ability to control the order of the ActiveRecord., _(*1)

, _(*2)

Install

Install via Composer:, _(*3)

composer require paulzi/yii2-sortable

or add, _(*4)

"paulzi/yii2-sortable" : "^1.0"

to the require section of your composer.json file., _(*5)

Migrations

Add signed integer column to your model. For quick operation behavior, add index for scopes fields and sort attribute, example:, _(*6)

$this->createIndex('parent_sort', '{{%item}}', ['parent_id', 'sort']);

Configuring

use paulzi\sortable\SortableBehavior;

class Sample extends \yii\db\ActiveRecord
{
    public function behaviors() {
        return [
            [
                'class' => SortableBehavior::className(),
            ],
        ];
    }
}

Options

• $query = null - list of attributes, callback or ActiveQuery, to find scope element. See below.
• $sortAttribute = 'sort' - sort attribute in table schema.
• $step = 100 - gap size between elements.
• $joinMode = true - search method of unallocated value. When joinMode is true, using join table with self. Otherwise, use the search in the window. Window size defined by $windowSize property.
• $windowSize = 1000 - defines the size of the search window, when joinMode is false.

Details of $query option: The list of attributes - a simple way to scope elements with the same content fields, the aliases do not need. You MUST use tableName() alias in ActiveQuery, when you are using joinMode., _(*7)

For example,, _(*8)

public function behaviors()
{
    return [
        [
            'class' => SortableBehavior::className(),
            'query' => ['parent_id'],
        ]
    ];
}

This is equivalent to:, _(*9)

public function behaviors()
{
    return [
        [
            'class' => SortableBehavior::className(),
            'query' => function ($model) {
                $tableName = $model->tableName();
                return $model->find()->andWhere(["{$tableName}.[[parent_id]]" => $model->parent_id]);
            },
        ]
    ];
}

Usage

Getting sort attribute value:, _(*10)

$model = Sample::findOne(1);
$position = $model->getSortablePosition();

To move as the first item:, _(*11)

$model = new Sample(['parent_id' => 1]);
$model->moveFirst()->save(); // inserting new node

To move as the last item:, _(*12)

$model = Sample::findOne(1);
$model->moveLast()->save(); // move existing node

To move an item to a specific position:, _(*13)

$model = Sample::findOne(1);
$model->moveTo(-33, true)->save(); // move to position -33, and move existing items forward
$model = Sample::findOne(2);
$model->moveTo(4, false)->save(); // move to position 4, and move existing items backward

To move an item before another: Note: If you need to change scope, do it manually, _(*14)

$model1 = new Sample(['parent_id' => 1]);
$model2 = Sample::findOne(2);
$model1->moveBefore($model2)->save(); // move $model1 before $model2

To move an item after another: Note: If you need to change scope, do it manually, _(*15)

$model1 = Sample::findOne(1);
$model2 = Sample::findOne(2);
$model1->parent_id = $model2->parent_id;
$model1->moveAfter($model2)->save(); // move $model1 after $model2 with change scope

Reorder item with the neighboring elements:, _(*16)

$model = Sample::findOne(1);
$model->reorder(true); // reorder with center zero
$model = Sample::findOne(2);
$model->reorder(false); // reorder from zero

SortableTrait

You can use optional SortableTrait, if you need it (for example, you are using something like ISortable interface)., _(*17)