Add ActiveQueryInterface::resetWith() (#496)

vjik · web-flow · commit b199dde6525f · 2025-11-05T10:06:52.000+03:00
diff --git a/src/ActiveQuery.php b/src/ActiveQuery.php
@@ -392,6 +392,16 @@ public function resetJoinsWith(): void
         $this->joinsWith = [];
     }
 
+    public function resetWith(): static
+    {
+        $this->with = [];
+        $this->joinsWith = array_map(
+            static fn (JoinWith $joinWith) => $joinWith->withoutEagerLoading(),
+            $this->joinsWith,
+        );
+        return $this;
+    }
+
     public function innerJoinWith(array|string $with, array|bool $eagerLoading = true): static
     {
         return $this->joinWith($with, $eagerLoading, 'INNER JOIN');
diff --git a/src/ActiveQueryInterface.php b/src/ActiveQueryInterface.php
@@ -101,6 +101,16 @@ public function with(array|string ...$with): static;
      */
     public function getWith(): array;
 
+    /**
+     * Resets the relations that this query should be performed with.
+     *
+     * This method clears all relations set via {@see with()} and disables eager loading for relations
+     * set via {@see joinWith()}, while keeping the JOIN clauses intact.
+     *
+     * @return static The query object itself.
+     */
+    public function resetWith(): static;
+
     /**
      * Specifies the relation associated with the junction table for use in a relational query.
      *
diff --git a/src/JoinWith.php b/src/JoinWith.php
@@ -18,7 +18,7 @@ final class JoinWith
      */
     public function __construct(
         public readonly array $relations,
-        private readonly array|bool $eagerLoading,
+        private array|bool $eagerLoading,
         private readonly array|string $joinType,
     ) {
     }
@@ -64,4 +64,16 @@ public function getJoinType(string $name): string
             ? ($this->joinType[$name] ?? 'INNER JOIN')
             : $this->joinType;
     }
+
+    /**
+     * Creates a new instance without eager loading.
+     *
+     * @return self A new instance without eager loading.
+     */
+    public function withoutEagerLoading(): self
+    {
+        $new = clone $this;
+        $new->eagerLoading = false;
+        return $new;
+    }
 }
diff --git a/tests/ActiveQueryTest.php b/tests/ActiveQueryTest.php
@@ -131,6 +131,27 @@ public function testGetWith(): void
         $this->assertSame(['orders', 'profile'], $query->getWith());
     }
 
+    public function testResetWith(): void
+    {
+        $query = Customer::query()->with('orders', 'profile');
+
+        $query->resetWith();
+
+        $this->assertSame([], $query->getWith());
+    }
+
+    public function testResetWithForJoinWith(): void
+    {
+        $query = Customer::query()->with('orders')->joinWith('profile');
+
+        $query->resetWith();
+        $this->assertSame([], $query->getWith());
+
+        $joinsWith = $query->getJoinsWith();
+        $this->assertCount(1, $joinsWith);
+        $this->assertSame([], $joinsWith[0]->getWith());
+    }
+
     public function testInnerJoinWith(): void
     {
         $joinsWith = Customer::query()->innerJoinWith('profile')->getJoinsWith();
