https://github.com/thoss/laravel-gap-sort
Sortable behaviour for Eloquent models with gap algorithm
https://github.com/thoss/laravel-gap-sort
eloquent gap laravel performant php sort trait
Last synced: 5 months ago
JSON representation
Sortable behaviour for Eloquent models with gap algorithm
- Host: GitHub
- URL: https://github.com/thoss/laravel-gap-sort
- Owner: thoss
- License: mit
- Created: 2023-04-24T08:37:01.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-05-05T07:32:54.000Z (about 3 years ago)
- Last Synced: 2025-08-13T14:39:36.536Z (11 months ago)
- Topics: eloquent, gap, laravel, performant, php, sort, trait
- Language: PHP
- Homepage:
- Size: 153 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sortable behaviour for Eloquent models with gap algorithm
[](LICENSE)
[](https://github.com/thoss/laravel-gap-sort/releases)
[](https://packagist.org/packages/thoss/laravel-gap-sort)
This package provides a way to sort items in a table using the "Gap" algorithm, which is a more efficient way of reordering items in a table than using incremental values. It takes into account the gap between the order values of adjacent items and calculates the new order value for the main item based on the positions of the previous and next items.
So you can sort an item to any position with just one operation, you don't have to change other items!
[Description of the class Thoss\GapSort\SortModel](SORTMODEL_DESCRIPTION.md)
## Requirement
- PHP 8.1
- Laravel 9/10
- Your order column must be an integer (recommended is unsigned integer)
## Installation
You can install this package using composer.
Just run the command below.
```
composer require thoss/laravel-gap-sort
```
Optionally you can publish the config file with:
```bash
php artisan vendor:publish --tag=gap-sort-config
```
This is the content of the file that will be published in `config/gap-sort.php`
```php
return [
/*
* The name of the column that will be used to sort models.
*/
'order_column' => 'order',
/*
* The gap between the sorted items
*/
'order_gap' => 1000,
/*
* Indicates wheter the "/sort" route will be automaticaly added when you use the route ::register method
*/
'resource_registrar_with_sort' => false,
];
```
## Usage
To add sortable behaviour to your model you must:
1. Use the trait `Thoss\GapSort\Traits\Sortable` in your Model.
2. Optionally specify which column will be used as the order column. The default is `order_column`.
3. Optionally specify which gap between the sorted items you want to use. The default is `order_gap`.
> The larger the gap, the lower the probability that the table will have to be reinitialized
4. You can initialize an existing Table with the order gap, maybe in a Migration file
```php
dispatch(new SortModel(modelString: YourModel::class, initTable:true));
```
### Use the sorting with an REST API
1. register `/sort` Route
(with the enabled resource registrar you can easily add the `/sort` Route)
```php
Route::resource('salutations', 'SalutationsController', ['with' => ['sort']]);
```
2. Dispatch the `SortModel` Job in your Controller
```php
use Thoss\GapSort\Requests\SortRequest;
use Thoss\GapSort\SortModel;
public function sort(SortRequest $request)
{
return $this->dispatchSync(new SortModel(MyModel::class));
}
```
## Example Requests with a 100 gap
Item1 is sorted between 2 and 3
```
Current List:
- Item1 (order 100)
- Item2 (order 200)
- Item3 (order 300)
POST /api/myresource/sort
{
"main": 1,
"previous": 2,
"next": 3,
}
After Sort:
- Item2 (order 200)
- Item1 (order 250)
- Item3 (order 300)
```
Item1 is sorted to the last
```
Current List:
- Item1 (order 100)
- Item2 (order 200)
- Item3 (order 300)
POST /api/myresource/sort
{
"main": 1,
"previous": 3,
}
After Sort:
- Item2 (order 200)
- Item3 (order 300)
- Item1 (order 350)
```
Item3 is sorted to the first
```
Current List:
- Item1 (order 100)
- Item2 (order 200)
- Item3 (order 300)
POST /api/myresource/sort
{
"main": 3,
"next": 1,
}
After Sort:
- Item3 (order 50)
- Item1 (order 100)
- Item2 (order 200)
```
## Testing
```bash
composer test
```
## Alternatives
- [https://github.com/ninoman/laravel-sortable](https://github.com/ninoman/laravel-sortable)
- [https://github.com/spatie/eloquent-sortable](https://github.com/spatie/eloquent-sortable)