muffin/orderly

Default ordering (behavior) for CakePHP 3

Orderly

, _(*1)

Allows setting default order for your tables., _(*2)

Install

Using Composer:, _(*3)

composer require muffin/orderly

Then load the plugin using the console command:, _(*4)

bin/cake plugin load Muffin/Orderly

What is does

Orderly allow you to set default ORDER clause for your table's SELECT queries., _(*5)

Usage

Here's how you can add the Orderly behavior for your tables:, _(*6)

// By default orders by display field of table.
$this->addBehavior('Muffin/Orderly.Orderly');

// Default ordering using specified field.
$this->addBehavior('Muffin/Orderly.Orderly', ['order' => $this->aliasField('field_name')]);

Value for order key can any valid value that \Cake\ORM\Query::orderBy() takes. The default order clause will only be applied to the primary query and when no custom order clause has already been set for the query., _(*7)

You can also configure the behavior to apply the default order based on required condition using callback option. The order will be applied if callback returns true:, _(*8)

$this->addBehavior('Muffin/Orderly.Orderly', [
    'order' => ['Alias.field_name' => 'DESC'],
    'callback' => function (\Cake\ORM\Query $query, \ArrayObject $options, bool $primary) {
        //return a boolean
    }
]);

The behavior can also be configured with multiple orders which are applied based on return value of their respective callbacks:, _(*9)

$this->addBehavior('Muffin/Orderly.Orderly', [
    [
        'order' => ['Alias.field_name' => 'DESC'],
        'callback' => function (\Cake\ORM\Query $query, \ArrayObject $options, bool $primary) {
            //return a boolean
        }
    ],
    [
        'order' => ['Alias.another_field'],
        'callback' => function (\Cake\ORM\Query $query, \ArrayObject $options, bool $primary) {
            //return a boolean
        }
    ],
]);

Patches & Features

• Fork
• Mod, fix
• Test - this is important, so it's not unintentionally broken
• Commit - do not mess with license, todo, version, etc. (if you do change any, bump them into commits of their own that I can ignore when I pull)
• Pull request - bonus point for topic branches

To ensure your PRs are considered for upstream, you MUST follow the CakePHP coding standards., _(*10)

Bugs & Feedback

http://github.com/usemuffin/orderly/issues, _(*11)

License

Copyright (c) 2015-Present, Use Muffin and licensed under The MIT License., _(*12)