Merge pull request #3035 from OzanKurt/patch-7

feat: Ability to use deep relations for searching

Author: yajra

src/EloquentDataTable.php

@@ -81,13 +81,35 @@ protected function getPrimaryKeyName(): string
     /**
      * @inheritDoc
      */
-    protected function compileQuerySearch($query, string $column, string $keyword, string $boolean = 'or'): void
+    protected function compileQuerySearch($query, string $column, string $keyword, string $boolean = 'or', bool $nested = false): void
     {
+        if (substr_count($column, '.') > 1) {
+            $parts = explode('.', $column);
+            $firstRelation = array_shift($parts);
+            $column = implode('.', $parts);
+
+            if ($this->isMorphRelation($firstRelation)) {
+                $query->{$boolean.'WhereHasMorph'}(
+                    $firstRelation,
+                    '*',
+                    function (EloquentBuilder $query) use ($column, $keyword) {
+                        parent::compileQuerySearch($query, $column, $keyword, '');
+                    }
+                );
+            } else {
+                $query->{$boolean.'WhereHas'}($firstRelation, function (EloquentBuilder $query) use ($column, $keyword) {
+                    self::compileQuerySearch($query, $column, $keyword, '', true);
+                });
+            }
+
+            return;
+        }
+
         $parts = explode('.', $column);
         $newColumn = array_pop($parts);
         $relation = implode('.', $parts);
 
-        if ($this->isNotEagerLoaded($relation)) {
+        if (!$nested && $this->isNotEagerLoaded($relation)) {
             parent::compileQuerySearch($query, $column, $keyword, $boolean);
 
             return;

tests/Integration/DeepRelationTest.php

@@ -0,0 +1,70 @@
+<?php
+
+namespace Yajra\DataTables\Tests\Integration;
+
+use Yajra\DataTables\DataTables;
+use Yajra\DataTables\Tests\TestCase;
+use Yajra\DataTables\Tests\Models\Post;
+use Yajra\DataTables\Tests\Models\User;
+use Illuminate\Foundation\Testing\DatabaseTransactions;
+
+class DeepRelationTest extends TestCase
+{
+    use DatabaseTransactions;
+
+    /** @test */
+    public function it_returns_all_records_with_the_relation_when_called_without_parameters()
+    {
+        $response = $this->getJsonResponse();
+        $response->assertJson([
+            'draw'            => 0,
+            'recordsTotal'    => 60,
+            'recordsFiltered' => 60,
+        ]);
+
+        $this->assertCount(60, $response->json()['data']);
+    }
+
+    /** @test */
+    public function it_can_perform_global_search_on_the_relation()
+    {
+        $response = $this->getJsonResponse([
+            'search' => ['value' => '[email protected]'],
+        ]);
+
+        $response->assertJson([
+            'draw'            => 0,
+            'recordsTotal'    => 60,
+            'recordsFiltered' => 3,
+        ]);
+
+        $this->assertCount(3, $response->json()['data']);
+    }
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->app['router']->get('/relations/deep', function (DataTables $datatables) {
+            $query = Post::with('user.roles')->select('posts.*');
+
+            return $datatables
+                ->eloquent($query)
+                ->toJson();
+        });
+    }
+
+    protected function getJsonResponse(array $params = [])
+    {
+        $data = [
+            'columns' => [
+                ['data' => 'user.roles.role', 'name' => 'user.roles.role', 'searchable' => 'true', 'orderable' => 'true'],
+                ['data' => 'user.name', 'name' => 'user.name', 'searchable' => 'true', 'orderable' => 'true'],
+                ['data' => 'user.email', 'name' => 'user.email', 'searchable' => 'true', 'orderable' => 'true'],
+                ['data' => 'title', 'name' => 'title', 'searchable' => 'true', 'orderable' => 'true'],
+            ],
+        ];
+
+        return $this->call('GET', '/relations/deep', array_merge($data, $params));
+    }
+}