fix(pivot): only use unique classes in the pivot union (Fixes #1606) (#…

…1607) * fix(pivot): only use unique classes in the pivot union (Fixes #1606) * composer fix-style --------- Co-authored-by: laravel-ide-helper <[email protected]>
barryvdh · Oct 29, 2024 · 07e3bd8 · 07e3bd8
1 parent 7c2fa01
commit 07e3bd8
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 6 deletions.
diff --git a/src/Console/ModelsCommand.php b/src/Console/ModelsCommand.php
@@ -720,7 +720,7 @@ public function getPropertiesFromMethods($model)
                                     $relationReturnType === 'many' ||
                                     (
                                         !$relationReturnType &&
-                                        strpos(get_class($relationObj), 'Many') !== false
+                                        str_contains(get_class($relationObj), 'Many')
                                     )
                                 ) {
                                     if ($relationObj instanceof BelongsToMany) {
@@ -729,16 +729,22 @@ public function getPropertiesFromMethods($model)
                                             $pivot = $this->getClassNameInDestinationFile($model, $pivot);
 
                                             if ($existingPivot = ($this->properties[$relationObj->getPivotAccessor()] ?? null)) {
-                                                // If the pivot is already set, we need to append the type to it
-                                                $pivot .= '|' . $existingPivot['type'];
+                                                $existingClasses = explode('|', $existingPivot['type']);
+
+                                                if (!in_array($pivot, $existingClasses)) {
+                                                    array_unshift($existingClasses, $pivot);
+                                                }
                                             } else {
-                                                // pivots are not always set
-                                                $pivot .= '|null';
+                                                // No existing pivot property, so we need to add a null type
+                                                $existingClasses = [$pivot, 'null'];
                                             }
 
+                                            // create a union type of all pivot classes
+                                            $unionType = implode('|', $existingClasses);
+
                                             $this->setProperty(
                                                 $relationObj->getPivotAccessor(),
-                                                $pivot,
+                                                $unionType,
                                                 true,
                                                 false
                                             );

diff --git a/tests/Console/ModelsCommand/Pivot/Models/ModelWithPivot.php b/tests/Console/ModelsCommand/Pivot/Models/ModelWithPivot.php
@@ -33,6 +33,12 @@ public function relationCustomPivotUsingSameAccessor()
             ->using(CustomPivot::class);
     }
 
+    public function relationCustomPivotUsingSameAccessorAndClass()
+    {
+        return $this->belongsToMany(ModelwithPivot::class)
+            ->using(CustomPivot::class);
+    }
+
     public function relationWithDifferentCustomPivotUsingSameAccessor()
     {
         return $this->belongsToMany(ModelwithPivot::class)

diff --git a/tests/Console/ModelsCommand/Pivot/__snapshots__/Test__test__1.php b/tests/Console/ModelsCommand/Pivot/__snapshots__/Test__test__1.php
@@ -14,6 +14,8 @@
  * @property-read DifferentCustomPivot|CustomPivot|null $pivot
  * @property-read \Illuminate\Database\Eloquent\Collection<int, ModelWithPivot> $relationCustomPivotUsingSameAccessor
  * @property-read int|null $relation_custom_pivot_using_same_accessor_count
+ * @property-read \Illuminate\Database\Eloquent\Collection<int, ModelWithPivot> $relationCustomPivotUsingSameAccessorAndClass
+ * @property-read int|null $relation_custom_pivot_using_same_accessor_and_class_count
  * @property-read CustomPivot|null $customAccessor
  * @property-read \Illuminate\Database\Eloquent\Collection<int, ModelWithPivot> $relationWithCustomPivot
  * @property-read int|null $relation_with_custom_pivot_count
@@ -52,6 +54,12 @@ public function relationCustomPivotUsingSameAccessor()
             ->using(CustomPivot::class);
     }
 
+    public function relationCustomPivotUsingSameAccessorAndClass()
+    {
+        return $this->belongsToMany(ModelwithPivot::class)
+            ->using(CustomPivot::class);
+    }
+
     public function relationWithDifferentCustomPivotUsingSameAccessor()
     {
         return $this->belongsToMany(ModelwithPivot::class)