Merge pull request #2 from dextermb/feature/collection-manipulator

Feature/collection manipulator

Author: DivineOmega

README.md

@@ -14,7 +14,7 @@ composer require langleyfoxall/react-dynamic-data-table-laravel-api
 
 First, create a new route in your API routes file for the data table response, and point it to a controller.
 
-In this controller method, create a new `DataTableResponder` passing it the model you wish to return data about, and the provided instance of the `Request` object. You can optionally specify changes to the query (such as sorting, or filtering) using the `query` method. You can also change number of records shown per page with the `setPerPage` method.
+In this controller method, create a new `DataTableResponder` passing it the model you wish to return data about, and the provided instance of the `Request` object. You can optionally specify changes to the query (such as sorting, or filtering) using the `query` method. If you want to alter the data before it gets returned in some way, such as changing attribute values or appending custom attributes, you can take advantage of `collectionManipulator`. You can also change number of records shown per page with the `setPerPage` method.
 
 See the example usage below.
 
@@ -28,10 +28,15 @@ class UsersController extends Controller
     public function dataTable(Request $request)
     {
         return (new DataTableResponder(User::class, $request))
-            ->query(function($query) {  // Optional, default: none
+            ->query(function($query) {                                   // Optional, default: none
                 $query->where('name', 'like', 'B%');
             })
-            ->setPerPage(10)            // Optional, default: 15
+            ->collectionManipulator(function (Collection $collection) {  // Optional, default: none
+                $collection->map(function($user) {
+                    $user->name = title_case($user->name);
+                });
+            })
+            ->setPerPage(10)                                             // Optional, default: 15
             ->respond();
     }
 }

src/DataTableResponder.php

@@ -26,6 +26,11 @@ class DataTableResponder
      */
     private $queryManipulator;
 
+    /**
+     * @var callable
+     */
+    private $collectionManipulator;
+
     /**
      * @var int
      */
@@ -75,6 +80,18 @@ public function query(callable $queryManipulator)
         return $this;
     }
 
+    /**
+     * Sets the callable used to manipulate the query results collection
+     * 
+     * @param callable $collectionManipulator
+     * @return DataTableResponder
+     */
+    public function collectionManipulator(callable $collectionManipulator)
+    {
+        $this->collectionManipulator = $collectionManipulator;
+        return $this;
+    }
+
     /**
      * Builds the Eloquent query based on the request.
      *
@@ -109,13 +126,35 @@ private function paginateQuery(Builder $query)
         return $query->paginate($this->perPage);
     }
 
+    /**
+     * @param \Illuminate\Contracts\Pagination\LengthAwarePaginator $results
+     * @return \Illuminate\Contracts\Pagination\LengthAwarePaginator
+     */
+    private function manipulateCollection($results)
+    {
+        $collection = $results->getCollection();
+        $manipulator = $this->collectionManipulator;
+
+        if ($manipulator) {
+            $manipulated = $manipulator($collection);
+
+            if ($manipulated) {
+                $results->setCollection($manipulated);
+            }
+        }
+
+        return $results;
+    }
+
     /**
      * @return \Illuminate\Http\JsonResponse
      */
     public function respond()
     {
         $query = $this->buildQuery($this->request);
+
         $results = $this->paginateQuery($query);
+        $results = $this->manipulateCollection($results);
 
         return DataTableResponse::success($results)->json();
     }