Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/usemuffin/orderly
Default ordering for your CakePHP tables
https://github.com/usemuffin/orderly
cakephp cakephp-plugin ordering php
Last synced: 3 months ago
JSON representation
Default ordering for your CakePHP tables
- Host: GitHub
- URL: https://github.com/usemuffin/orderly
- Owner: UseMuffin
- License: mit
- Created: 2016-02-04T14:36:30.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2023-09-27T18:59:45.000Z (about 1 year ago)
- Last Synced: 2024-07-13T02:04:08.317Z (4 months ago)
- Topics: cakephp, cakephp-plugin, ordering, php
- Language: PHP
- Homepage:
- Size: 31.3 KB
- Stars: 22
- Watchers: 7
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome-cakephp - Muffin/Orderly plugin - Allows setting default order for your tables. (ORM / Database / Datamapping)
README
# Orderly
[](https://github.com/UseMuffin/Orderly/actions/workflows/ci.yml?query=branch%3Amaster)
[](https://app.codecov.io/gh/UseMuffin/Orderly)
[](https://packagist.org/packages/muffin/orderly)
[](LICENSE)
Allows setting default order for your tables.
## Install
Using [Composer][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:
```php
// 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`:
```php
$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:
```php
$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][standards].
## Bugs & Feedback
http://github.com/usemuffin/orderly/issues
## License
Copyright (c) 2015-Present, [Use Muffin][muffin] and licensed under [The MIT License][mit].
[cakephp]:http://cakephp.org
[composer]:http://getcomposer.org
[mit]:http://www.opensource.org/licenses/mit-license.php
[muffin]:http://usemuffin.com
[standards]:http://book.cakephp.org/5/en/contributing/cakephp-coding-conventions.html