Skip to content

Document HasSortableRelations trait #89

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
LukeTowers merged 3 commits into from
Oct 12, 2022
Merged

Document HasSortableRelations trait #89

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
54a882a
document HasSortableRelations trait
mjauvin Jul 27, 2022
aa51e11
Update database-traits.md
LukeTowers Jul 27, 2022
b97f31a
fix url and placement for has sortable trait doc
mjauvin Aug 26, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions database-traits.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
- [Sluggable](#sluggable)
- [Revisionable](#revisionable)
- [Sortable](#sortable)
- [HasSortableRelations](#has-sortable-relations)
- [Simple Tree](#simple-tree)
- [Nested Tree](#nested-tree)
- [Validation](#validation)
Expand Down Expand Up @@ -676,3 +677,20 @@ class Product extends Model
protected $nullable = ['sku'];
}
```

<a name="hassortablerelations"></a>
## HasSortableRelations

Add this trait to your model in order to allow its relations to be sorted/reordered.

```php
class MyModel extends model
{
use \Winter\Storm\Database\Traits\HasSortableRelations;

/**
* @var array Relations that can be sorted/reordered and the column name to use for sorting/reordering.
*/
public $sortableRelations = ['relation_name' => 'sort_order_column'];
...
}