This package provides a trait that adds sortable behaviour to an Eloquent model.

The value of the ordercolumn of a new record of a model is determined by the maximum value of the ordercolumn of all records of that model + 1.

The package also provides a query scope to fetch all the records in the right order.

Spatie is webdesign agency in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.

This package can be installed through Composer.

$ composer require spatie/eloquent-sortable

You must add this service provider:

// Laravel 4: app/config/app.php 
// Laravel 5: config/app.php

'providers' => [ 
	'...',
	'Spatie\EloquentSortable\SortableServiceProvider',
];

To add sortable behaviour to your model you must:

1. specify that the model will conform to Spatie\EloquentSortable\SortableInterface
   
2. use the trait Spatie\EloquentSortable\Sortable
   
3. specify which column will be used as the ordercolumn
   

use Spatie\EloquentSortable\Sortable;
use Spatie\EloquentSortable\SortableTrait;

class MyModel extends Eloquent implements Sortable
{

    use SortableTrait;

    public $sortable = [
        'order_column_name' => 'order_column',
        'sort_when_creating' => true,
    ];
    
    ...
}

If you don't set a value $sortable['order_column_name'] the package will asume that your order column name will be 'order_column';

If you don't set a value $sortable['sort_when_creating'] the package will automatically assign the highest order number to a new model;

Assuming that the db-table for MyModel is empty:

$myModel = new MyModel();
$myModel->save(); // order_column for this record will be set to 1

$myModel = new MyModel();
$myModel->save(); // order_column for this record will be set to 2

$myModel = new MyModel();
$myModel->save(); // order_column for this record will be set to 3


//the trait also provides the ordered query scope
$orderedRecords = MyModel::ordered()->get(); 

You can set a new order for all the records using the setNewOrder-method

/**
 * the record for model id 3 will have record_column value 1
 * the record for model id 1 will have record_column value 2
 * the record for model id 2 will have record_column value 3
 */
MyModel::setNewOrder([3,1,2]);

Optionally you can pass the starting order number as the second argument.

/**
 * the record for model id 3 will have record_column value 11
 * the record for model id 1 will have record_column value 12
 * the record for model id 2 will have record_column value 13
 */
MyModel::setNewOrder([3,1,2], 10);

The package contains some integration/smoke tests, set up with Orchestra. The tests can be run via phpunit.

$ vendor/bin/phpunit

Please see CHANGELOG for more information what has changed recently.

Please see CONTRIBUTING for details.

If you discover any security related issues, please email freek@spatie.be instead of using the issue tracker.

• Freek Van der Herten
• All Contributors

Spatie is webdesign agency in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.

The MIT License (MIT). Please see License File for more information.