Datatables : Ability to Map/Transform Resources

Datatables : Ability to Have closures Resolving Query, Fields on Transform and Also
Datatables : Abitlity to have HasMany relations & Fixed issues with Relationships Loading

Author: nikuscs

src/Datatables/Columns/Column.php

@@ -15,6 +15,7 @@ class Column implements CoreContracts\HasToArray
     use Concerns\CanBeHidden;
     use Concerns\CanBeSortable;
     use Concerns\CanBeRaw;
+    use Concerns\CanBeSelected;
     use Concerns\HasLabel;
     use Concerns\HasName;
     use Concerns\HasKey;

src/Datatables/Columns/Concerns/CanBeSelected.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Flavorly\VanillaComponents\Datatables\Columns\Concerns;
+
+use Illuminate\Support\Str;
+
+trait CanBeSelected
+{
+    public function selectable(): bool
+    {
+        return ! Str::of($this->getName())->contains('.');
+    }
+}

src/Datatables/Concerns/HasColumns.php

@@ -45,7 +45,11 @@ protected function getColumns(): Collection
 
     protected function getColumnKeys(): Collection
     {
-        return collect($this->columns)->map(fn ($column) => $column->getName());
+        return collect($this->columns)
+            ->filter(fn (Column $column) => $column->selectable())
+            ->map(function (Column $column) {
+                return $column->getName();
+            });
     }
 
     public function getColumnByKey(string $columnKey): ?Column

src/Datatables/Concerns/HasPrimaryKey.php

@@ -8,7 +8,7 @@ trait HasPrimaryKey
 
     public function primaryKey(): ?string
     {
-        return $this->query?->getModel()->getKeyName();
+        return $this->getQuery()?->getModel()->getKeyName();
     }
 
     public function setupPrimaryKey(): void
@@ -18,6 +18,6 @@ public function setupPrimaryKey(): void
 
     public function getPrimaryKey(): string
     {
-        return $this->primaryKey ?? $this->query?->getModel()->getKeyName() ?? 'id';
+        return $this->primaryKey ?? $this->primaryKey() ?? 'id';
     }
 }

src/Datatables/Concerns/HasResponse.php

@@ -35,7 +35,11 @@ public function response(?Builder $queryOrModel = null): DatatableResource
             ->fromRequest();
 
         // Attempt to always get a query builder
-        $baseQuery = $this->resolveQueryOrModel($queryOrModel);
+        if ($queryOrModel !== null) {
+            $this->withQuery($queryOrModel);
+        }
+
+        $baseQuery = $this->getQuery();
 
         /** @var Model|Searchable $model */
         $model = $baseQuery->getModel();
@@ -49,10 +53,12 @@ public function response(?Builder $queryOrModel = null): DatatableResource
             function (Builder $query) use ($baseQuery) {
                 $query
                     // Select columns
-                    ->select($this->getColumnKeys()->toArray())
+                    // TODO: check if we can resolve columns to select in a smarter way
+                    //->select($this->getColumnKeys()->toArray())
 
                     // Merge previous query
                     ->mergeConstraintsFrom($baseQuery)
+                    ->setEagerLoads($baseQuery->getEagerLoads())
 
                     // Perform sorting
                     ->when($this->data->hasSorting(), function (Builder|ScoutBuilder $subQuery) {
@@ -100,6 +106,19 @@ function (Builder $query) use ($baseQuery) {
         // Dispatch the action
         $this->dispatchAction();
 
-        return (new DatatableResource($paginator))->rightSideMaximumPages(3);
+        $response = (new DatatableResource($paginator));
+
+        // Ensure we can transform the data that is being displayed
+        if (method_exists($this, 'transform')) {
+            $response->transformResponseUsing(fn ($record) => $this->transform($record));
+        }
+
+        // Ensure we can transform the data that is being displayed
+        $pagination = 3;
+        if (property_exists($this, 'paginationItems')) {
+            $pagination = $this->paginationItems;
+        }
+
+        return $response->rightSideMaximumPages($pagination);
     }
 }

src/Datatables/Concerns/InteractsWithQueryBuilder.php

@@ -4,30 +4,42 @@
 
 use Closure;
 use Illuminate\Database\Eloquent\Builder;
-use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\Relations\Relation;
 use Laravel\Scout\Builder as ScoutBuilder;
 
 trait InteractsWithQueryBuilder
 {
-    protected Builder|ScoutBuilder|null $query = null;
+    protected Builder|ScoutBuilder|null|Closure $query = null;
 
-    public function query(): Builder|ScoutBuilder|null
+    public function query(): mixed
+    {
+        return $this->query;
+    }
+
+    public function getQuery()
     {
         return $this->query;
     }
 
     public function setupQuery(): void
     {
-        $this->query = $this->query();
+        $this->query = $this->resolveQueryOrModel($this->query());
     }
 
-    protected function resolveQueryOrModel(Builder|Model|string|Closure|null $queryOrModel = null): Builder
+    public function withQuery(mixed $query)
     {
-        // Query already present or set
-        if (null !== $this->query && $queryOrModel === null) {
-            return $this->query;
+        if (null === $query) {
+            return $this;
         }
+        $this->query = $this->resolveQueryOrModel($query);
+
+        $this->setupPrimaryKey();
 
+        return $this;
+    }
+
+    protected function resolveQueryOrModel(mixed $queryOrModel = null): Builder
+    {
         // If the user has not provided a query or passed a string ( class ) we will try to
         // get the query from the model
         if (is_string($queryOrModel)) {
@@ -38,6 +50,10 @@ protected function resolveQueryOrModel(Builder|Model|string|Closure|null $queryO
             $queryOrModel = $this->evaluate($queryOrModel);
         }
 
+        if ($queryOrModel instanceof Relation) {
+            return $queryOrModel->getQuery();
+        }
+
         // Attempt to always get a query builder
         return $queryOrModel instanceof Builder ? $queryOrModel : $queryOrModel->query();
     }

src/Datatables/Http/Resources/DatatableResource.php

@@ -2,6 +2,7 @@
 
 namespace Flavorly\VanillaComponents\Datatables\Http\Resources;
 
+use Closure;
 use Flavorly\VanillaComponents\Core\Concerns\InteractsWithPagination;
 use Flavorly\VanillaComponents\Datatables\Paginator\PaginatedResourceResponse;
 use Illuminate\Http\Resources\Json\ResourceCollection;
@@ -10,13 +11,34 @@ class DatatableResource extends ResourceCollection
 {
     use InteractsWithPagination;
 
-    public function toArray($request)
+    protected ?Closure $transformUsing = null;
+
+    public function toArray($request): array
     {
+        if (null !== $this->transformUsing) {
+            $this->collection = $this
+                ->collection
+                ->map($this->transformUsing)
+                ->map(function ($item) {
+                    return collect($item)->map(function ($value, $key) {
+                        return $value instanceof Closure ? $value() : $value;
+                    })
+                    ->toArray();
+                });
+        }
+
         return [
             'data' => $this->collection,
         ];
     }
 
+    public function transformResponseUsing(Closure $callback)
+    {
+        $this->transformUsing = $callback;
+
+        return $this;
+    }
+
     protected function preparePaginatedResponse($request)
     {
         if ($this->preserveAllQueryParameters) {