https://github.com/stephenjude/default-model-sorting
Add custom default sorting column to your eloquent model.
https://github.com/stephenjude/default-model-sorting
eloquent laravel model orderby php sorting
Last synced: about 1 year ago
JSON representation
Add custom default sorting column to your eloquent model.
- Host: GitHub
- URL: https://github.com/stephenjude/default-model-sorting
- Owner: stephenjude
- License: mit
- Created: 2020-07-01T17:57:33.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-03-27T15:09:25.000Z (about 2 years ago)
- Last Synced: 2025-04-10T03:56:31.830Z (about 1 year ago)
- Topics: eloquent, laravel, model, orderby, php, sorting
- Language: PHP
- Homepage:
- Size: 34.2 KB
- Stars: 37
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Default Model Sorting
[](https://packagist.org/packages/stephenjude/default-model-sorting)
[](https://travis-ci.org/stephenjude/default-model-sorting)
[](https://packagist.org/packages/stephenjude/default-model-sorting)
Add default sorting column to your eloquent model.
## Installation
You can install the package via composer:
```bash
composer require stephenjude/default-model-sorting
```
## Basic Usage
``` php
use Stephenjude\DefaultModelSorting\Traits\DefaultOrderBy;
class Article extends Model
{
use DefaultOrderBy;
protected static $orderByColumn = 'title';
}
```
### Column Sorting Order
You can change the default column sorting order by adding the `$orderByColumnDirection` property inside your eloquent model.
```php
use Stephenjude\DefaultModelSorting\Traits\DefaultOrderBy;
class Article extends Model
{
use DefaultOrderBy;
protected static $orderByColumn = 'title';
protected static $orderByColumnDirection = 'desc';
}
```
## Configurations
### Publishing Config
You can publish the config file by running the `vendor:publish command`
```
php artisan vendor:publish --provider="Stephenjude\DefaultModelSorting\DefaultModelSortingServiceProvider" --tag="config"
```
### Configuring Default Column Sorting Order
You can change the default sorting order inside the config file:
```
'order_by' => 'asc',
```
### Testing
``` bash
composer test
```
### Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
### Security
If you discover any security related issues, please email hello@stephenjude.me instead of using the issue tracker.
## Credits
- [Stephen Jude](https://github.com/stephenjude)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
## Laravel Package Boilerplate
This package was generated using the [Laravel Package Boilerplate](https://laravelpackageboilerplate.com).