Repository files navigation

Allows setting default order for your tables.

UsingComposer:

composer require muffin/orderly

Then load the plugin using the console command:

bin/cake plugin load Muffin/Orderly

Orderly allow you to set defaultORDER clause for your table'sSELECT queries.

Here's how you can add theOrderly behavior for your tables:

// 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 fororder 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 nocustom order clause has already been set for the query.

You can also configure the behavior to apply the default order based on requiredcondition usingcallback option. The order will be applied if callback returnstrue:

$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 basedon return value of their respective callbacks:

$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        }    ],]);

• 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 oftheir 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 theCakePHP coding standards.

http://github.com/usemuffin/orderly/issues

Copyright (c) 2015-Present,Use Muffin and licensed underThe MIT License.