Download the PHP package rethinking/eloquent-sortable-relations without Composer
On this page you can find all versions of the php package rethinking/eloquent-sortable-relations. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package eloquent-sortable-relations
Eloquent sortable relations
This package provides a new relation to Eloquent model
The value of the related model position column is determined by the maximum value of this column for parent record (through foreign key).
The package provides a relation class itself, traits for owner side and related side and an interface.
Installation
This package can be installed through composer
Usage
To add sortable behaviour for your relations follow next steps:
- Use
Rethinking\Eloquent\Relations\Sortable\HasSortedRelations
trait on the owning Model - Implement
Rethinking\Eloquent\Relations\Sortable\Sortable
interface on related Model. For simplicity, useRethinking\Eloquent\Relations\Sortable\HasSortingContext
trait - Define the sorting context for Model (the owning side)
- Optionally define the column name for position attribute on your model (
position
by default in trait) by overriding trait methodHasSortingContext::getPositionColumnName(): string
Example
Owning side:
Related side:
By default the sorting column name assumed to be position For modifying this, override (in case trait is used) or implement the interface method
For manually setting sorting order for existing items, use method HasMnaySorted::setSortingOrder(iterable $ids, $start = 1)
This will set the array index of $id + $start as position field
In case, position sequence corrupted, you can manually trigger the HasManySorted::resort()
method.
When creating the new relation for owning side, the position will be automatically calculated as maximum position value for owner foreign key
max(position) + 1
.
Assume, owner has no related items. The calculation of the next position will be triggered when using any of the following methods:
When dissociate the related model from it owner, the position will be reset to null
Relations
Extension provides 3 types of sorted relations:
HasManySorted
Items will be fetched based on position within Owner::class
:
HasManySortedThrough
Items will be fetched through Middle::class
based on position of Item::class
within Middle::class
:
HasManyThroughSorted
Items will be fetched through Middle::class
based on position of Middle::class
within Owner::class
:
Test
The package contains integration tests, set up with Orchestra. Tests can be run through composer script
License
The MIT License (MIT). Please see License File for more information.