muffin / orderly
Default ordering (behavior) for CakePHP
Installs: 114 085
Dependents: 1
Suggesters: 0
Security: 0
Stars: 22
Watchers: 7
Forks: 5
Type:cakephp-plugin
Requires
- cakephp/orm: ^5.0
Requires (Dev)
- cakephp/cakephp: ^5.0
- phpunit/phpunit: ^10.1
This package is auto-updated.
Last update: 2024-09-27 21:09:12 UTC
README
Allows setting default order for your tables.
Install
Using Composer:
composer require muffin/orderly
Then load the plugin using the console command:
bin/cake plugin load Muffin/Orderly
What is does
Orderly allow you to set default ORDER
clause for your table's SELECT
queries.
Usage
Here's how you can add the Orderly
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 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.
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
:
$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:
$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.
Bugs & Feedback
http://github.com/usemuffin/orderly/issues
License
Copyright (c) 2015-Present, Use Muffin and licensed under The MIT License.