zigastrgar/orderable

Ordering package for Laravel 5.x

Orderable Laravel Package

This is my very first Laravel package. I find it useful for me :) When I work with projects where I need to run a lot of ORDER BY queries., _(*1)

Instalation

Add the Orderable package to your composer.json file., _(*2)

{
    "require": {
        "zigastrgar/orderable": "^1.0"
    }
}

OR, _(*3)

Simply run this in command line, _(*4)

composer require zigastrgar/orderable

Usage

Go to any model and add this to the model., _(*5)

use ZigaStrgar\Orderable\Orderable;

class Article extends Model {
    use Orderable;

    public function orderable(){
        return [
            'id' => 'DESC',
            'title' => 'ASC',
            'user_id'
        ];
    }
}

If you don't use the key like in user_id case it will default to DESC., _(*6)

Running "Orderable"

It's super simple., _(*7)

Article::all();

Apply only specific rule

From now on, you can also do something like this., _(*8)

Article::order(); //Equals to Article::all();

or, _(*9)

Article::order(['title']);

and only rule for title will bi applied., _(*10)

Running without "Orderable"

Same. Very simple stuff., _(*11)

Article::unorderable();

No scopes applied., _(*12)

Remove specific rule

Article::unorderable(['title']);

In this case the rule for title won't be applied., _(*13)