Utilize built-in CodeIgniter query builder functions for filtering an…

…d ordering - Refactored filtering and ordering logic to leverage CodeIgniter's built-in query builder functions - Simplify getting column name by a resolver
ngekoding · Nov 11, 2024 · bb0ea19 · bb0ea19
1 parent f60394f
commit bb0ea19
Show file tree

Hide file tree

Showing 2 changed files with 56 additions and 75 deletions.
diff --git a/src/Config.php b/src/Config.php
@@ -15,12 +15,16 @@ class Config
             'countAllResults' => 'count_all_results',
             'orderBy' => 'order_by',
             'where' => 'where',
+            'like' => 'like',
+            'orLike' => 'or_like',
             'limit' => 'limit',
             'get' => 'get',
             'QBSelect' => 'qb_select',
             'getFieldNames' => 'list_fields',
             'getResult' => 'result',
             'getResultArray' => 'result_array',
+            'groupStart' => 'group_start',
+            'groupEnd' => 'group_end'
         ]
     ];
 

diff --git a/src/DataTables.php b/src/DataTables.php
@@ -171,6 +171,34 @@ protected function setReturnedFieldNames()
         }
     }
 
+    /**
+     * Resolves the column name
+     * 
+     * @param int|string $column The column index or name, depending on `asObject`
+     * @return string|null The resolved column name or NULL if out of bounds
+     */
+    protected function resolveColumnName($column)
+    {
+        if ( ! $this->asObject) {
+            $fieldIndex = $this->sequenceNumber ? $column - 1 : $column;
+
+            // Skip sequence number and extra column
+            if (
+                ($this->sequenceNumber && $column == 0) OR
+                $fieldIndex > count($this->returnedFieldNames) - 1
+            ) return NULL;
+
+            $column = $this->returnedFieldNames[$fieldIndex];
+        }
+
+        // Checking if it using a column alias
+        $column = isset($this->columnAliases[$column])
+                    ? $this->columnAliases[$column]
+                    : $column;
+
+        return $column;
+    }
+
     /**
      * Add sequence number to the output
      * @param string $key Used when returning object output as the key
@@ -188,84 +216,48 @@ public function addSequenceNumber($key = 'sequenceNumber')
     protected function filter()
     {
         $globalSearch = [];
-		$columnSearch = [];
-
-        $fieldNamesLength = count($this->returnedFieldNames);
 
         // Global column filtering
 		if ($this->request->get('search') && ($keyword = $this->request->get('search')['value']) != '') {
 			foreach ($this->request->get('columns', []) as $request_column) {
 				if (filter_var($request_column['searchable'], FILTER_VALIDATE_BOOLEAN)) {
                     $column = $request_column['data'];
-
-                    if ( ! $this->asObject) {
-                        // Skip sequence number
-                        if ($this->sequenceNumber && $column == 0) continue;
-
-                        $fieldIndex = $this->sequenceNumber ? $column - 1 : $column;
-
-                        // Skip extra column
-                        if ($fieldIndex > $fieldNamesLength - 1) break;
-
-                        $column = $this->returnedFieldNames[$fieldIndex];
-                    }
-
-                    // Checking if it using a column alias
-                    $column = isset($this->columnAliases[$column])
-                                ? $this->columnAliases[$column]
-                                : $column;
+                    $column = $this->resolveColumnName($column);
 
-					$globalSearch[] = sprintf("`%s` LIKE '%%%s%%'", $column, $keyword);
+                    if (empty($column)) continue;
+
+					$globalSearch[] = $column;
 				}
 			}
 		}
 
+        // Apply global search criteria
+        if (!empty($globalSearch)) {
+            $this->queryBuilder->{$this->config->get('groupStart')}();
+
+            foreach ($globalSearch as $column) {
+                $this->queryBuilder->{$this->config->get('orLike')}($column, $keyword);    
+            }
+
+            $this->queryBuilder->{$this->config->get('groupEnd')}();
+        }
+
 		// Individual column filtering
 		foreach ($this->request->get('columns', []) as $request_column) {
 			if (
 				filter_var($request_column['searchable'], FILTER_VALIDATE_BOOLEAN) &&
 				($keyword = $request_column['search']['value']) != ''
 			) {
                 $column = $request_column['data'];
+                $column = $this->resolveColumnName($column);
+
+                if (empty($column)) continue;
 
-                if ( ! $this->asObject) {
-                    // Skip sequence number
-                    if ($this->sequenceNumber && $column == 0) continue;
-
-                    $fieldIndex = $this->sequenceNumber ? $column - 1 : $column;
-
-                    // Skip extra column
-                    if ($fieldIndex > $fieldNamesLength - 1) break;
-
-                    $column = $this->returnedFieldNames[$fieldIndex];
-                }
-
-                // Checking if it using a column alias
-                $column = isset($this->columnAliases[$column])
-                            ? $this->columnAliases[$column]
-                            : $column;
-
-				$columnSearch[] = sprintf("`%s` LIKE '%%%s%%'", $column, $keyword);
+				// Apply column-specific search criteria
+                $this->queryBuilder->{$this->config->get('like')}($column, $keyword);
 			}
 		}
 
-		// Merge global search & column search
-		$w_filter = '';
-
-		if ( ! empty($globalSearch)) {
-			$w_filter = '(' . implode(' OR ', $globalSearch) . ')';
-		}
-
-		if ( ! empty($columnSearch)) {
-			$w_filter = $w_filter === '' ?
-				implode(' AND ', $columnSearch) :
-				$w_filter . ' AND ' . implode(' AND ', $columnSearch);
-		}
-
-		if ($w_filter !== '') {
-			$this->queryBuilder->{$this->config->get('where')}($w_filter);
-		}
-
 		$this->recordsFiltered = $this->queryBuilder->{$this->config->get('countAllResults')}('', FALSE);
     }
 
@@ -275,35 +267,20 @@ protected function filter()
     protected function order()
     {
         if ($this->request->get('order') && count($this->request->get('order'))) {
-			$orders = [];
-            $fieldNamesLength = count($this->returnedFieldNames);
-
 			foreach ($this->request->get('order') as $order) {
 				$column_idx = $order['column'];
 				$request_column = $this->request->get('columns')[$column_idx];
 
 				if (filter_var($request_column['orderable'], FILTER_VALIDATE_BOOLEAN)) {
                     $column = $request_column['data'];
+                    $column = $this->resolveColumnName($column);
 
-                    if ( ! $this->asObject) {
-                        // Skip sequence number
-                        if ($this->sequenceNumber && $column == 0) continue;
-
-                        $fieldIndex = $this->sequenceNumber ? $column - 1 : $column;
-
-                        // Skip extra column
-                        if ($fieldIndex > $fieldNamesLength - 1) break;
-
-                        $column = $this->returnedFieldNames[$fieldIndex];
-                    }
+                    if (empty($column)) continue;
 
-					$orders[] = sprintf('`%s` %s', $column, strtoupper($order['dir']));
+                    // Apply order
+                    $this->queryBuilder->{$this->config->get('orderBy')}($column, $order['dir']);
 				}
 			}
-
-			if (!empty($orders)) {
-				$this->queryBuilder->{$this->config->get('orderBy')}(implode(', ', $orders));
-			}
 		}
     }