Merge pull request #19 from jr-cologne/where-clause-update

Add support for custom logical operators in where clause

Author: jr-cologne

README.md

@@ -200,6 +200,20 @@ if ($db->table('users')->delete([
 }
 ```
 
+### Custom Logical Operators in Where Clause
+
+Since the release of [version 2.3](https://github.com/jr-cologne/db-class/releases/tag/v2.3.0), a where clause can also have custom logical operators.
+
+This is how a where clause with custom logical operators could look like when retrieving data from a database:
+
+```php
+$data = $db->table('users')->select('*', [
+  'id' => 1,
+  '||',
+  'username' => 'test'
+])->retrieve();
+```
+
 ### Using PDO's functionality
 
 Since the database class is extending PDO, you can use the whole functionality of PDO with this class as well.

composer.json

@@ -1,7 +1,7 @@
 {
   "name": "jr-cologne/db-class",
   "type": "library",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "A simple database class with PHP, PDO and a query builder.",
   "keywords": [
     "database",
@@ -35,7 +35,7 @@
   ],
   "support": {
     "issues": "https://github.com/jr-cologne/db-class/issues",
-    "source": "https://github.com/jr-cologne/db-class/tree/v2.2.0",
+    "source": "https://github.com/jr-cologne/db-class/tree/v2.3.0",
     "docs": "https://github.com/jr-cologne/db-class/blob/README.md"
   }
 }

src/DB.php

@@ -13,7 +13,7 @@
  * @author JR Cologne <[email protected]>
  * @copyright 2018 JR Cologne
  * @license https://github.com/jr-cologne/db-class/blob/master/LICENSE MIT
- * @version v2.2.0
+ * @version v2.3.0
  * @link https://github.com/jr-cologne/db-class GitHub Repository
  * @link https://packagist.org/packages/jr-cologne/db-class Packagist site
  *
@@ -383,6 +383,11 @@ public function getPDOException() : PDOException {
    */
   protected function formatWhereData(array $where) : array {
     foreach ($where as $column => $value) {
+      if (is_numeric($column)) {
+        next($where);
+        continue;
+      }
+
       $where_data['where_' . $column] = $value;
     }
 

src/Exceptions/UnsupportedKeywordException.php

@@ -13,7 +13,7 @@
  * @author JR Cologne <[email protected]>
  * @copyright 2018 JR Cologne
  * @license https://github.com/jr-cologne/db-class/blob/master/LICENSE MIT
- * @version v2.2.0
+ * @version v2.3.0
  * @link https://github.com/jr-cologne/db-class GitHub Repository
  * @link https://packagist.org/packages/jr-cologne/db-class Packagist site
  *

src/QueryBuilder.php

@@ -13,7 +13,7 @@
  * @author JR Cologne <[email protected]>
  * @copyright 2018 JR Cologne
  * @license https://github.com/jr-cologne/db-class/blob/master/LICENSE MIT
- * @version v2.2.0
+ * @version v2.3.0
  * @link https://github.com/jr-cologne/db-class GitHub Repository
  * @link https://packagist.org/packages/jr-cologne/db-class Packagist site
  *
@@ -183,9 +183,15 @@ protected function formatWhere(array $where) : string {
     $where_clause = '';
 
     foreach ($where as $column => $value) {
+      if (is_numeric($column)) {
+        $where_clause .= " {$value} ";
+        next($where);
+        continue;
+      }
+
       $where_clause .= "`{$column}` = :where_{$column}";
 
-      if (next($where) !== false) {
+      if ( next($where) !== false && !is_null(key($where)) && !is_numeric(key($where)) ) {
         $where_clause .= ' && ';
       }
     }

tests/DBTest.php

@@ -13,7 +13,7 @@
  * @author JR Cologne <[email protected]>
  * @copyright 2018 JR Cologne
  * @license https://github.com/jr-cologne/db-class/blob/master/LICENSE MIT
- * @version v2.2.0
+ * @version v2.3.0
  * @link https://github.com/jr-cologne/db-class GitHub Repository
  * @link https://packagist.org/packages/jr-cologne/db-class Packagist site
  *
@@ -119,6 +119,15 @@ public function test_retrieve_method_returns_data_based_on_where_clause() {
     );
   }
 
+  public function test_retrieve_method_returns_data_based_on_where_clause_with_custom_operator() {
+    $this->assertEquals('John',
+      $this->getDBConnection()
+        ->table('users')
+        ->select('username', [ 'id' => 1, '||', 'username' => 'John', '&&', 'password' => 'ilovecats123' ])
+        ->retrieve('first')['username']
+    );
+  }
+
   public function test_retrieve_method_returns_data_based_on_fetch_mode() {
     $this->assertInternalType('object',
       $this->getDBConnection()
@@ -338,6 +347,26 @@ public function test_update_method_updates_data_in_database() {
     );
   }
 
+  public function test_update_method_updates_data_in_database_based_on_custom_where_clause() {
+    $this->getDBConnection()
+      ->table('users')
+      ->update([
+        'username' => 'Johnny'
+      ], [
+        'username' => 'John',
+        '||',
+        'id' => 1,
+        'password' => 'ilovecats123'
+      ]);
+
+    $this->assertEquals('Johnny',
+      $this->getDBConnection()
+        ->table('users')
+        ->select('username', [ 'username' => 'Johnny' ])
+        ->retrieve('first')['username'] ?? null
+    );
+  }
+
   public function test_update_method_without_where_clause_updates_all_data_in_database() {
     $this->getDBConnection()
       ->table('users')
@@ -388,6 +417,24 @@ public function test_delete_method_deletes_data_in_database() {
     );
   }
 
+  public function test_delete_method_deletes_data_in_database_based_on_custom_where_clause() {
+    $this->getDBConnection()
+      ->table('users')
+      ->delete([
+        'id' => 1,
+        'username' => 'John',
+        'AND',
+        'password' => 'ilovecats123'
+      ]);
+
+    $this->assertCount(1,
+      $this->getDBConnection()
+        ->table('users')
+        ->select('*')
+        ->retrieve()
+    );
+  }
+
   public function test_delete_method_without_where_clause_deletes_all_data_in_database() {
     $this->getDBConnection()
       ->table('users')

tests/DatabaseTestCase.php

@@ -13,7 +13,7 @@
  * @author JR Cologne <[email protected]>
  * @copyright 2018 JR Cologne
  * @license https://github.com/jr-cologne/db-class/blob/master/LICENSE MIT
- * @version v2.2.0
+ * @version v2.3.0
  * @link https://github.com/jr-cologne/db-class GitHub Repository
  * @link https://packagist.org/packages/jr-cologne/db-class Packagist site
  *