Add addOrderEscape / addOrderEscapes for raw order_by support

Author: ngekoding

README.md

@@ -176,6 +176,18 @@ $datatables->addColumnAliases([
 $datatables->addSequenceNumber();
 $datatables->addSequenceNumber('rowNumber'); // It will be rowNumber
 
+// Add order escape for a specific column
+// Useful when ordering by raw expressions or aggregate functions like COUNT()
+// This will skip identifier protection for the given column
+$datatables->addOrderEscape('name', FALSE);
+
+// Add order escapes for multiple columns at once
+// Each key is the column name, and the value is the escape flag (TRUE/FALSE)
+$datatables->addOrderEscapes([
+  'name' => FALSE,
+  'category' => FALSE
+]);
+
 // Don't forget to call generate to get the results
 $datatables->generate();
 ```

src/DataTables.php

@@ -17,6 +17,7 @@ class DataTables
     protected $returnedFieldNames = [];
     protected $formatters = [];
     protected $extraColumns = [];
+    protected $orderEscapes = [];
 
     protected $recordsTotal;
     protected $recordsFiltered;
@@ -110,6 +111,41 @@ public function addColumnAliases($aliases)
         return $this;
     }
 
+    /**
+     * Add an order escape rule for a specific column
+     * Useful when ordering by raw expressions or columns with aggregate functions
+     * @param string $column The column name
+     * @param bool $escape Whether to escape/protect the identifier (TRUE/FALSE)
+     * 
+     * @return $this
+     */
+    public function addOrderEscape($column, $escape)
+    {
+        $column = $this->resolveColumnName($column);
+        
+        $this->orderEscapes[$column] = $escape;
+        return $this;
+    }
+
+    /**
+     * Add multiple order escape rules at once
+     * @param array $columns An array of column => escape_boolean pairs
+     * 
+     * @return $this
+     */
+    public function addOrderEscapes($columns)
+    {
+        if (!is_array($columns)) {
+            throw new \Exception('The $columns parameter must be an array with key => escape_boolean.');
+        }
+
+        foreach ($columns as $column => $escape) {
+            $this->addOrderEscape($column, $escape);
+        }
+
+        return $this;
+    }
+
     /**
      * Only return the column as defined
      * @param string|array $columns The columns to only will be returned
@@ -273,8 +309,12 @@ protected function order()
 
                     if (empty($column)) continue;
 
+                    $escape = isset($this->orderEscapes[$column])
+                        ? $this->orderEscapes[$column]
+                        : NULL;
+
                     // Apply order
-                    $this->queryBuilder->{$this->config->get('orderBy')}($column, $order['dir']);
+                    $this->queryBuilder->{$this->config->get('orderBy')}($column, $order['dir'], $escape);
 				}
 			}
 		}