Merge pull request #4 from dextermb/feature/add-disallow-ordering-by

Add overrideOrderByLogic and disallowOrderingBy

Author: DivineOmega

composer.json

@@ -5,7 +5,8 @@
         "php": "^7.0.0",
         "illuminate/http": "^5.1",
         "illuminate/database": "^5.1",
-        "langleyfoxall/helpers-laravel": "^1.10"
+        "langleyfoxall/helpers-laravel": "^1.10",
+        "illuminate/support": "^5.1"
     },
     "autoload": {
         "psr-4": {

src/DataTableResponder.php

@@ -4,6 +4,7 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Http\Request;
+use Illuminate\Support\Str;
 
 /**
  * Class DataTableResponder
@@ -26,6 +27,11 @@ class DataTableResponder
      */
     private $queryManipulator;
 
+    /**
+     * @var array|callable[]
+     */
+    private $orderByOverrides = [];
+
     /**
      * @var callable
      */
@@ -80,9 +86,21 @@ public function query(callable $queryManipulator)
         return $this;
     }
 
+    /**
+     * Sets the field name to callable mapping array used to override the query order by logic
+     *
+     * @param array|callable[] $orderByOverride
+     * @return DataTableResponder
+     */
+    public function overrideOrderByLogic(array $orderByOverrides)
+    {
+        $this->orderByOverrides = $orderByOverrides;
+        return $this;
+    }
+
     /**
      * Sets the callable used to manipulate the query results collection
-     * 
+     *
      * @param callable $collectionManipulator
      * @return DataTableResponder
      */
@@ -106,10 +124,18 @@ private function buildQuery(Request $request)
         $query = $this->model->query();
 
         if ($orderByField && $orderByDirection) {
-            $query->orderBy($orderByField, $orderByDirection);
+            if (in_array($orderByField, array_keys($this->orderByOverrides))) {
+                call_user_func_array(
+                    $this->orderByOverrides[$orderByField],
+                    [$query, $orderByDirection]
+                );
+            } else {
+                $query->orderBy($orderByField, $orderByDirection);
+            }
         }
 
         $queryManipulator = $this->queryManipulator;
+
         if ($queryManipulator) {
             $queryManipulator($query);
         }
@@ -146,6 +172,35 @@ private function manipulateCollection($results)
         return $results;
     }
 
+    /**
+     * @return array|string[]
+     */
+    private function disallowOrderingBy()
+    {
+        $methods = get_class_methods($this->model);
+        $customAttributes = [];
+
+        foreach($methods as $method) {
+            if (!preg_match('/^get(\w+)Attribute$/', $method, $matches)) {
+                continue;
+            }
+
+            if (empty($matches[1])) {
+                continue;
+            }
+
+            $customAttribute = Str::snake($matches[1]);
+
+            if (in_array($customAttribute, array_keys($this->orderByOverrides))) {
+                continue;
+            }
+
+            $customAttributes[] = $customAttribute;
+        }
+
+        return $customAttributes;
+    }
+
     /**
      * @return \Illuminate\Http\JsonResponse
      */
@@ -156,6 +211,8 @@ public function respond()
         $results = $this->paginateQuery($query);
         $results = $this->manipulateCollection($results);
 
-        return DataTableResponse::success($results)->json();
+        $disallowOrderingBy = $this->disallowOrderingBy();
+
+        return DataTableResponse::success($results, ['disallow_ordering_by' => $disallowOrderingBy])->json();
     }
 }