Added support for morphTo (#158)

Author: luisdalmolin

README.md

@@ -87,6 +87,14 @@ Turns out, if you join a polymorphic relationship, Eloquent Power Joins automati
 Post::joinRelationship('images');
 ```
 
+You can also join MorphTo relationships.
+
+```php
+Image::joinRelationship('imageable', morphable: Post::class);
+```
+
+Note: Querying morph to relationships only supports one morphable type at a time.
+
 **Applying conditions & callbacks to the joins**
 
 Now, let's say you want to apply a condition to the join you are making. You simply need to pass a callback as the second parameter to the `joinRelationship` method.

src/Mixins/JoinRelationship.php

@@ -93,7 +93,8 @@ public function joinRelationship(): Closure
             $callback = null,
             $joinType = 'join',
             $useAlias = false,
-            bool $disableExtraConditions = false
+            bool $disableExtraConditions = false,
+            string $morphable = null
         ) {
             $joinType = JoinsHelper::$joinMethodsMap[$joinType] ?? $joinType;
             $useAlias = is_string($callback) ? false : $useAlias;
@@ -145,7 +146,8 @@ public function joinRelationship(): Closure
                 joinType: $joinType,
                 callback: $callback,
                 alias: $alias,
-                disableExtraConditions: $disableExtraConditions
+                disableExtraConditions: $disableExtraConditions,
+                morphable: $morphable,
             );
 
             return $this;

src/Mixins/RelationshipsExtraMethods.php

@@ -4,14 +4,16 @@
 
 use Kirschbaum\PowerJoins\StaticCache;
 use Kirschbaum\PowerJoins\PowerJoinClause;
+use Kirschbaum\PowerJoins\Tests\Models\Post;
 use Illuminate\Database\Eloquent\SoftDeletes;
 use Illuminate\Database\Eloquent\Relations\HasOne;
 use Illuminate\Database\Eloquent\Relations\HasMany;
+use Illuminate\Database\Eloquent\Relations\MorphTo;
 use Illuminate\Database\Eloquent\Relations\BelongsTo;
+use Illuminate\Database\Eloquent\Relations\MorphToMany;
 use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 use Illuminate\Database\Eloquent\Relations\HasManyThrough;
 use Illuminate\Database\Eloquent\Relations\MorphOneOrMany;
-use Illuminate\Database\Eloquent\Relations\MorphToMany;
 
 /**
  * @method \Illuminate\Database\Eloquent\Model getModel()
@@ -49,20 +51,16 @@ class RelationshipsExtraMethods
      */
     public function performJoinForEloquentPowerJoins()
     {
-        return function ($builder, $joinType = 'leftJoin', $callback = null, $alias = null, bool $disableExtraConditions = false) {
-            if ($this instanceof MorphToMany) {
-                return $this->performJoinForEloquentPowerJoinsForMorphToMany($builder, $joinType, $callback, $alias, $disableExtraConditions);
-            } elseif ($this instanceof BelongsToMany) {
-                return $this->performJoinForEloquentPowerJoinsForBelongsToMany($builder, $joinType, $callback, $alias, $disableExtraConditions);
-            } elseif ($this instanceof MorphOneOrMany) {
-                return $this->performJoinForEloquentPowerJoinsForMorph($builder, $joinType, $callback, $alias, $disableExtraConditions);
-            } elseif ($this instanceof HasMany || $this instanceof HasOne) {
-                return $this->performJoinForEloquentPowerJoinsForHasMany($builder, $joinType, $callback, $alias, $disableExtraConditions);
-            } elseif ($this instanceof HasManyThrough) {
-                return $this->performJoinForEloquentPowerJoinsForHasManyThrough($builder, $joinType, $callback, $alias, $disableExtraConditions);
-            } else {
-                return $this->performJoinForEloquentPowerJoinsForBelongsTo($builder, $joinType, $callback, $alias, $disableExtraConditions);
-            }
+        return function ($builder, $joinType = 'leftJoin', $callback = null, $alias = null, bool $disableExtraConditions = false, string $morphable = null) {
+            return match (true) {
+                $this instanceof MorphToMany => $this->performJoinForEloquentPowerJoinsForMorphToMany($builder, $joinType, $callback, $alias, $disableExtraConditions),
+                $this instanceof BelongsToMany => $this->performJoinForEloquentPowerJoinsForBelongsToMany($builder, $joinType, $callback, $alias, $disableExtraConditions),
+                $this instanceof MorphOneOrMany => $this->performJoinForEloquentPowerJoinsForMorph($builder, $joinType, $callback, $alias, $disableExtraConditions),
+                $this instanceof HasMany || $this instanceof HasOne => $this->performJoinForEloquentPowerJoinsForHasMany($builder, $joinType, $callback, $alias, $disableExtraConditions),
+                $this instanceof HasManyThrough => $this->performJoinForEloquentPowerJoinsForHasManyThrough($builder, $joinType, $callback, $alias, $disableExtraConditions),
+                $this instanceof MorphTo => $this->performJoinForEloquentPowerJoinsForMorphTo($builder, $joinType, $callback, $alias, $disableExtraConditions, $morphable),
+                default => $this->performJoinForEloquentPowerJoinsForBelongsTo($builder, $joinType, $callback, $alias, $disableExtraConditions),
+            };
         };
     }
 
@@ -243,6 +241,38 @@ protected function performJoinForEloquentPowerJoinsForMorph()
         };
     }
 
+    /**
+     * Perform the JOIN clause for when calling the morphTo method from the morphable class.
+     */
+    protected function performJoinForEloquentPowerJoinsForMorphTo()
+    {
+        return function ($builder, $joinType, $callback = null, $alias = null, bool $disableExtraConditions = false, string $morphable = null) {
+            $modelInstance = new $morphable;
+
+            $builder->{$joinType}($modelInstance->getTable(), function ($join) use ($modelInstance, $callback, $disableExtraConditions) {
+                $join->on(
+                    "{$this->getModel()->getTable()}.{$this->getForeignKeyName()}",
+                    '=',
+                    "{$modelInstance->getTable()}.{$modelInstance->getKeyName()}"
+                )->where("{$this->getModel()->getTable()}.{$this->getMorphType()}", '=', $modelInstance->getMorphClass());
+
+                if ($disableExtraConditions === false && $this->usesSoftDeletes($this->query->getModel())) {
+                    $join->whereNull($this->query->getModel()->getQualifiedDeletedAtColumn());
+                }
+
+                if ($disableExtraConditions === false) {
+                    $this->applyExtraConditions($join);
+                }
+
+                if ($callback && is_callable($callback)) {
+                    $callback($join);
+                }
+            }, $this->getModel());
+
+            return $this;
+        };
+    }
+
     /**
      * Perform the JOIN clause for the HasMany (or similar) relationships.
      */

src/PowerJoinClause.php

@@ -76,6 +76,11 @@ public function on($first, $operator = null, $second = null, $boolean = 'and'):
         return $this;
     }
 
+    public function morphableClass(string $modelClass)
+    {
+        dd($modelClass);
+    }
+
     public function getModel()
     {
         return $this->model;

tests/JoinRelationshipTest.php

@@ -795,4 +795,25 @@ public function test_it_doesnt_fail_to_join_the_same_query_repeatedly()
             }
         }
     }
+
+    public function test_join_morph_to_morphable_class()
+    {
+        factory(Image::class, 5)->state('owner:post')->create();
+        factory(Image::class, 4)->state('owner:user')->create();
+
+        $postImages = Image::query()
+            ->joinRelationship('imageable', morphable: Post::class)
+            ->get();
+
+        $sql = Image::query()
+            ->joinRelationship('imageable', morphable: Post::class)
+            ->toSql();
+
+        $this->assertStringContainsString(
+            'inner join "posts" on "images"."imageable_id" = "posts"."id" and "images"."imageable_type" = ?',
+            $sql
+        );
+
+        $this->assertCount(5, $postImages);
+    }
 }

tests/Models/User.php

@@ -2,11 +2,12 @@
 
 namespace Kirschbaum\PowerJoins\Tests\Models;
 
+use Kirschbaum\PowerJoins\PowerJoins;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\SoftDeletes;
-use Kirschbaum\PowerJoins\PowerJoins;
 use Illuminate\Database\Eloquent\Relations\HasOne;
 use Illuminate\Database\Eloquent\Relations\HasMany;
+use Illuminate\Database\Eloquent\Relations\MorphMany;
 use Illuminate\Database\Eloquent\Relations\BelongsToMany;
 use Illuminate\Database\Eloquent\Relations\HasManyThrough;
 
@@ -64,6 +65,11 @@ public function commentsThroughPosts(): HasManyThrough
         return $this->hasManyThrough(Comment::class, Post::class);
     }
 
+    public function images(): MorphMany
+    {
+        return $this->morphMany(Image::class, 'imageable');
+    }
+
     public function scopeHasPublishedPosts($query)
     {
         $query->powerJoinWhereHas('posts', function ($join) {

tests/database/factories/ImageFactory.php

@@ -2,6 +2,7 @@
 
 use Carbon\Carbon;
 use Kirschbaum\PowerJoins\Tests\Models\Post;
+use Kirschbaum\PowerJoins\Tests\Models\User;
 use Kirschbaum\PowerJoins\Tests\Models\Image;
 
 $factory->define(Image::class, function (Faker\Generator $faker) {
@@ -17,6 +18,13 @@
     },
 ]);
 
+$factory->state(Image::class, 'owner:user', [
+    'imageable_type' => User::class,
+    'imageable_id' => function () {
+        return factory(User::class)->create()->id;
+    },
+]);
+
 $factory->state(Image::class, 'cover', [
     'cover' => 1,
 ]);