Merge pull request #3073 from yajra/format-column-callable

feat: allow closure on formatColumn

Author: yajra

src/DataTableAbstract.php

@@ -10,7 +10,6 @@
 use Psr\Log\LoggerInterface;
 use Yajra\DataTables\Contracts\DataTable;
 use Yajra\DataTables\Contracts\Formatter;
-use Yajra\DataTables\Exceptions\Exception;
 use Yajra\DataTables\Processors\DataProcessor;
 use Yajra\DataTables\Utilities\Helper;
 
@@ -174,10 +173,8 @@ public static function create($source)
 
     /**
      * @param  string|array  $columns
-     * @param  string|\Yajra\DataTables\Contracts\Formatter  $formatter
+     * @param  string|callable|\Yajra\DataTables\Contracts\Formatter  $formatter
      * @return $this
-     *
-     * @throws \Yajra\DataTables\Exceptions\Exception
      */
     public function formatColumn($columns, $formatter): static
     {
@@ -193,7 +190,29 @@ public function formatColumn($columns, $formatter): static
             return $this;
         }
 
-        throw new Exception('$formatter must be an instance of '.Formatter::class);
+        if (is_callable($formatter)) {
+            foreach ((array) $columns as $column) {
+                $this->addColumn(
+                    $column.'_formatted',
+                    function ($row) use ($column, $formatter) {
+                        return $formatter(data_get($row, $column), $row);
+                    }
+                );
+            }
+
+            return $this;
+        }
+
+        foreach ((array) $columns as $column) {
+            $this->addColumn(
+                $column.'_formatted',
+                function ($row) use ($column) {
+                    return data_get($row, $column);
+                }
+            );
+        }
+
+        return $this;
     }
 
     /**

tests/Integration/EloquentDataTableTest.php

@@ -121,6 +121,46 @@ public function it_can_return_formatted_columns()
         $this->assertEquals(Carbon::parse($user->created_at)->format('Y-m-d'), $data['created_at_formatted']);
     }
 
+    /** @test */
+    public function it_can_return_formatted_column_using_closure()
+    {
+        $crawler = $this->call('GET', '/eloquent/formatColumn-closure');
+
+        $crawler->assertJson([
+            'draw' => 0,
+            'recordsTotal' => 20,
+            'recordsFiltered' => 20,
+        ]);
+
+        $user = User::find(1);
+        $data = $crawler->json('data')[0];
+
+        $this->assertTrue(isset($data['created_at']));
+        $this->assertTrue(isset($data['created_at_formatted']));
+
+        $this->assertEquals(Carbon::parse($user->created_at)->format('Y-m-d'), $data['created_at_formatted']);
+    }
+
+    /** @test */
+    public function it_can_return_formatted_column_on_invalid_formatter()
+    {
+        $crawler = $this->call('GET', '/eloquent/formatColumn-fallback');
+
+        $crawler->assertJson([
+            'draw' => 0,
+            'recordsTotal' => 20,
+            'recordsFiltered' => 20,
+        ]);
+
+        $user = User::find(1);
+        $data = $crawler->json('data')[0];
+
+        $this->assertTrue(isset($data['created_at']));
+        $this->assertTrue(isset($data['created_at_formatted']));
+
+        $this->assertEquals($user->created_at, $data['created_at_formatted']);
+    }
+
     /** @test */
     public function it_accepts_a_relation()
     {
@@ -152,5 +192,17 @@ protected function setUp(): void
                              ->formatColumn('created_at', new DateFormatter('Y-m-d'))
                              ->toJson();
         });
+
+        $router->get('/eloquent/formatColumn-closure', function (DataTables $dataTable) {
+            return $dataTable->eloquent(User::query())
+                             ->formatColumn('created_at', fn ($value, $row) => Carbon::parse($value)->format('Y-m-d'))
+                             ->toJson();
+        });
+
+        $router->get('/eloquent/formatColumn-fallback', function (DataTables $dataTable) {
+            return $dataTable->eloquent(User::query())
+                             ->formatColumn('created_at', 'InvalidFormatter::class')
+                             ->toJson();
+        });
     }
 }