From 54a882ab412852e0a3c33341cdc9e2f42f067e56 Mon Sep 17 00:00:00 2001 From: Marc Jauvin Date: Wed, 27 Jul 2022 12:42:24 -0400 Subject: [PATCH 1/3] document HasSortableRelations trait --- database-traits.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/database-traits.md b/database-traits.md index 86b755bc..a83400a6 100644 --- a/database-traits.md +++ b/database-traits.md @@ -11,6 +11,7 @@ - [Validation](#validation) - [Soft deleting](#soft-deleting) - [Nullable](#nullable) +- [HasSortableRelations](#hassortablerelations) Model traits are used to implement common functionality. @@ -676,3 +677,21 @@ class Product extends Model protected $nullable = ['sku']; } ``` + + +## 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']; +... +} From aa51e11f7efe3e7d222e7a2ba32351a1a37663cd Mon Sep 17 00:00:00 2001 From: Luke Towers Date: Wed, 27 Jul 2022 10:43:36 -0600 Subject: [PATCH 2/3] Update database-traits.md --- database-traits.md | 1 - 1 file changed, 1 deletion(-) diff --git a/database-traits.md b/database-traits.md index a83400a6..d4aab2fa 100644 --- a/database-traits.md +++ b/database-traits.md @@ -683,7 +683,6 @@ class Product extends Model Add this trait to your model in order to allow its relations to be sorted/reordered. - ```php class MyModel extends model { From b97f31ab6010dc3d9f877af7d25e1f084e9336b3 Mon Sep 17 00:00:00 2001 From: Marc Jauvin Date: Fri, 26 Aug 2022 14:47:20 -0400 Subject: [PATCH 3/3] fix url and placement for has sortable trait doc --- database-traits.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/database-traits.md b/database-traits.md index d4aab2fa..9bbbe4f3 100644 --- a/database-traits.md +++ b/database-traits.md @@ -6,12 +6,12 @@ - [Sluggable](#sluggable) - [Revisionable](#revisionable) - [Sortable](#sortable) +- [HasSortableRelations](#has-sortable-relations) - [Simple Tree](#simple-tree) - [Nested Tree](#nested-tree) - [Validation](#validation) - [Soft deleting](#soft-deleting) - [Nullable](#nullable) -- [HasSortableRelations](#hassortablerelations) Model traits are used to implement common functionality.