Making sure PowerJoinClause can be type-hinted

kirschbaum-development · Dec 7, 2023 · 4718c93 · 4718c93
1 parent e55fa70
commit 4718c93
Show file tree

Hide file tree

Showing 5 changed files with 57 additions and 25 deletions.
diff --git a/src/FakeJoinCallback.php b/src/FakeJoinCallback.php
@@ -5,10 +5,8 @@
 /**
  * @method static as(string $alias)
  */
-class FakeJoinCallback
+class FakeJoinCallback extends PowerJoinClause
 {
-    protected ?string $alias = null;
-
     public function getAlias(): ?string
     {
         return $this->alias;

diff --git a/src/JoinsHelper.php b/src/JoinsHelper.php
@@ -70,14 +70,12 @@ public function generateAliasForRelationship(Relation $relation, string $relatio
 
     /**
      * Get the join alias name from all the different options.
-     *
-     * @return string|null
      */
-    public function getAliasName(bool $useAlias, Relation $relation, string $relationName, string $tableName, $callback)
+    public function getAliasName(bool $useAlias, Relation $relation, string $relationName, string $tableName, $callback): null|string|array
     {
         if ($callback) {
             if (is_callable($callback)) {
-                $fakeJoinCallback = new FakeJoinCallback();
+                $fakeJoinCallback = new FakeJoinCallback($relation->getBaseQuery(), 'inner', $tableName);
                 $callback($fakeJoinCallback);
 
                 if ($fakeJoinCallback->getAlias()) {
@@ -86,7 +84,7 @@ public function getAliasName(bool $useAlias, Relation $relation, string $relatio
             }
 
             if (is_array($callback) && isset($callback[$tableName])) {
-                $fakeJoinCallback = new FakeJoinCallback();
+                $fakeJoinCallback = new FakeJoinCallback($relation->getBaseQuery(), 'inner', $tableName);
                 $callback[$tableName]($fakeJoinCallback);
 
                 if ($fakeJoinCallback->getAlias()) {

diff --git a/src/Mixins/JoinRelationship.php b/src/Mixins/JoinRelationship.php
@@ -117,13 +117,22 @@ public function joinRelationship(): Closure
 
             $relation = $this->getModel()->{$relationName}();
             $relationQuery = $relation->getQuery();
-            $alias = $joinHelper->getAliasName($useAlias, $relation, $relationName,
-                $relationQuery->getModel()->getTable(), $callback);
+            $alias = $joinHelper->getAliasName(
+                $useAlias,
+                $relation,
+                $relationName,
+                $relationQuery->getModel()->getTable(),
+                $callback
+            );
 
             if ($relation instanceof BelongsToMany && !is_array($alias)) {
-                $extraAlias = $joinHelper->getAliasName($useAlias, $relation, $relationName,
+                $extraAlias = $joinHelper->getAliasName(
+                    $useAlias,
+                    $relation,
+                    $relationName,
                     $relation->getTable(),
-                    $callback);
+                    $callback
+                );
                 $alias = [$extraAlias, $alias];
             }
 
@@ -260,11 +269,23 @@ public function joinNestedRelationship(): Closure
                     $relationCallback = $callback[$fullRelationName];
                 }
 
-                $alias = $joinHelper->getAliasName($useAlias, $relation, $relationName,
-                    $relation->getQuery()->getModel()->getTable(), $relationCallback);
+                $alias = $joinHelper->getAliasName(
+                    $useAlias,
+                    $relation,
+                    $relationName,
+                    $relation->getQuery()->getModel()->getTable(),
+                    $relationCallback
+                );
+
                 if ($alias && $relation instanceof BelongsToMany && !is_array($alias)) {
-                    $extraAlias = $joinHelper->getAliasName($useAlias, $relation, $relationName, $relation->getTable(),
-                        $relationCallback);
+                    $extraAlias = $joinHelper->getAliasName(
+                        $useAlias,
+                        $relation,
+                        $relationName,
+                        $relation->getTable(),
+                        $relationCallback
+                    );
+
                     $alias = [$extraAlias, $alias];
                 }
 

diff --git a/src/PowerJoinClause.php b/src/PowerJoinClause.php
@@ -37,14 +37,8 @@ class PowerJoinClause extends JoinClause
 
     /**
      * Create a new join clause instance.
-     *
-     * @param  \Illuminate\Database\Query\Builder  $parentQuery
-     * @param  string  $type
-     * @param  string  $table
-     * @param  \Illuminate\Database\Eloquent\Model  $model
-     * @return void
      */
-    public function __construct(Builder $parentQuery, $type, $table, Model $model = null)
+    public function __construct(Builder $parentQuery, $type, string $table, Model $model = null)
     {
         parent::__construct($parentQuery, $type, $table);
 
@@ -205,7 +199,7 @@ public function where($column, $operator = null, $value = null, $boolean = 'and'
      */
     public function withTrashed(): self
     {
-        if (! in_array(SoftDeletes::class, class_uses_recursive($this->getModel()))) {
+        if (! $this->getModel() || ! in_array(SoftDeletes::class, class_uses_recursive($this->getModel()))) {
             return $this;
         }
 
@@ -225,7 +219,7 @@ public function withTrashed(): self
      */
     public function onlyTrashed(): self
     {
-        if (! in_array(SoftDeletes::class, class_uses_recursive($this->getModel()))) {
+        if (! $this->getModel() || ! in_array(SoftDeletes::class, class_uses_recursive($this->getModel()))) {
             return $this;
         }
 
@@ -244,6 +238,10 @@ public function __call($name, $arguments)
     {
         $scope = 'scope' . ucfirst($name);
 
+        if (! $this->getModel()) {
+            return;
+        }
+
         if (method_exists($this->getModel(), $scope)) {
             return $this->getModel()->{$scope}($this, ...$arguments);
         } else {

diff --git a/tests/JoinRelationshipTest.php b/tests/JoinRelationshipTest.php
@@ -2,6 +2,7 @@
 
 namespace Kirschbaum\PowerJoins\Tests;
 
+use Kirschbaum\PowerJoins\PowerJoinClause;
 use Kirschbaum\PowerJoins\PowerJoins;
 use Kirschbaum\PowerJoins\Tests\Models\Group;
 use Kirschbaum\PowerJoins\Tests\Models\Post;
@@ -705,6 +706,22 @@ public function test_scope_inside_nested_where()
         );
     }
 
+    public function test_it_can_type_hint_power_join_clause()
+    {
+        Comment::query()->joinRelationship('post', function ($join) {
+            $join->where(fn (PowerJoinClause $query) => $query->published());
+        })->get();
+
+        $sql = Comment::query()->joinRelationship('post', function ($join) {
+            $join->where(fn (PowerJoinClause $query) => $query->published());
+        })->toSql();
+
+        $this->assertStringContainsString(
+            'inner join "posts" on "comments"."post_id" = "posts"."id" and "posts"."deleted_at" is null and ("posts"."published" = ?)',
+            $sql
+        );
+    }
+
     public function test_it_can_alias_belongs_to_many()
     {
         Group::query()->joinRelationship('posts', [