README

This package provides a simple Orderable trait that you can implement on your Eloquent models. It registers a couple of scopes that allow you to order models and also handles re-ordering models after creation.

Installation

You can install the package via Composer:

composer require c6digital/laravel-orderable

Usage

use C6Digital\Orderable\Concerns\Orderable;
use C6Digital\Orderable\Concerns\OrderableOptions;

class Post extends Model
{
    use Orderable;

    public static function getOrderableOptions(): OrderableOptions
    {
        return OrderableOptions::default()
            ->column('order')               // Set the column that is used to order this model.
            ->reorderOnCreate()             // Determine whether models should be re-ordered after creation.
            ->moveToEndOnCreate()           // Place newly created models at the end.
            ->moveToStartOnCreate()         // Place newly created models at the start.
            ->setOrderUsing(callback: ...); // Set the order manually using a custom callback.
    }
}

The default column is order, so make sure you add that to your database table. The package doesn't do it for you automatically.

Use the ordered(), orderedAsc() and orderedDesc() methods to order results in a query.

Post::query()
    ->ordered()     // Defaults to `ASC`.
    ->orderedAsc()  // Orders `ASC`.
    ->orderedDesc() // Orders `DESC`.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

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

c6digital / laravel-orderable

Maintainers

Details