Add named parameter support to methods proviging GQL access

Author: twalder-docnet

examples/query_params.php

@@ -0,0 +1,47 @@
+<?php
+/**
+ * Query parameter examples
+ *
+ * @author Tom Walder <[email protected]>
+ */
+require_once('boilerplate.php');
+
+// A single named parameter, "isbn"
+$obj_book = $obj_book_store->fetchOne("SELECT * FROM Book WHERE isbn = @isbn", ['isbn' => '1840224339']);
+describeResult($obj_book);
+
+// Fetch n results
+$arr_books = $obj_book_store->fetchAll("SELECT * FROM Book WHERE isbn < @isbn", ['isbn' => '1840224339']);
+describeResult($arr_books);
+
+// Query & pagination
+$arr_books = $obj_book_store->query("SELECT * FROM Book WHERE isbn > @isbn", ['isbn' => '1840224339']);
+while($arr_page = $obj_book_store->fetchPage(5)) {
+    describeResult($arr_page);
+}
+
+
+
+
+/**
+ * Helper function to simplify results display
+ *
+ * @param $mix_result
+ * @param bool $bol_recurse
+ */
+function describeResult($mix_result, $bol_recurse = FALSE)
+{
+    if($mix_result instanceof GDS\Entity) {
+        $str_class = get_class($mix_result);
+        echo "Found single result: [{$str_class}] {$mix_result->getKeyId()}, {$mix_result->title}, {$mix_result->isbn}, {$mix_result->author}", PHP_EOL;
+    } elseif (is_array($mix_result)) {
+        echo "Found ", count($mix_result), " results", PHP_EOL;
+        if($bol_recurse) {
+            foreach($mix_result as $mix_row) {
+                describeResult($mix_row);
+            }
+        }
+    } else {
+        echo "No result(s) found", PHP_EOL;
+    }
+}

src/GDS/Store.php

@@ -53,6 +53,13 @@ class Store
      */
     private $str_last_query = NULL;
 
+    /**
+     * Named parameters for the last query
+     *
+     * @var array|null
+     */
+    private $arr_last_params = NULL;
+
     /**
      * The last result cursor
      *
@@ -182,11 +189,13 @@ public function fetchByName($str_name)
      * Fetch Entities based on a GQL query
      *
      * @param $str_query
+     * @param array|null $arr_params
      * @return Entity[]
      */
-    public function query($str_query)
+    public function query($str_query, $arr_params = NULL)
     {
         $this->str_last_query = $str_query;
+        $this->arr_last_params = $arr_params;
         $this->str_last_cursor = NULL;
         return $this;
     }
@@ -195,33 +204,35 @@ public function query($str_query)
      * Fetch ONE Entity based on a GQL query
      *
      * @param $str_query
+     * @param array|null $arr_params
      * @return Entity
      */
-    public function fetchOne($str_query = NULL)
+    public function fetchOne($str_query = NULL, $arr_params = NULL)
     {
         if(NULL !== $str_query) {
-            $this->query($str_query);
+            $this->query($str_query, $arr_params);
         }
         $arr_results = $this->obj_gateway
             ->withTransaction($this->str_transaction_id)
-            ->gql($this->str_last_query . ' LIMIT 1');
+            ->gql($this->str_last_query . ' LIMIT 1', $this->arr_last_params);
         return $this->mapOneFromResults($arr_results);
     }
 
     /**
      * Fetch Entities (optionally based on a GQL query)
      *
      * @param $str_query
+     * @param array|null $arr_params
      * @return Entity[]
      */
-    public function fetchAll($str_query = NULL)
+    public function fetchAll($str_query = NULL, $arr_params = NULL)
     {
         if(NULL !== $str_query) {
-            $this->query($str_query);
+            $this->query($str_query, $arr_params);
         }
         $arr_results = $this->obj_gateway
             ->withTransaction($this->str_transaction_id)
-            ->gql($this->str_last_query);
+            ->gql($this->str_last_query, $this->arr_last_params);
         return $this->mapFromResults($arr_results);
     }
 
@@ -235,7 +246,7 @@ public function fetchAll($str_query = NULL)
     public function fetchPage($int_page_size, $mix_offset = NULL)
     {
         $str_offset = '';
-        $arr_params = [];
+        $arr_params = (array)$this->arr_last_params;
         if(NULL !== $mix_offset) {
             if(is_int($mix_offset)) {
                 $str_offset = 'OFFSET @intOffset';
@@ -248,6 +259,9 @@ public function fetchPage($int_page_size, $mix_offset = NULL)
             $str_offset = 'OFFSET @startCursor';
             $arr_params['startCursor'] = $this->str_last_cursor;
         }
+        if(empty($arr_params)) {
+            $arr_params = NULL;
+        }
         $arr_results = $this->obj_gateway
             ->withTransaction($this->str_transaction_id)
             ->gql($this->str_last_query . " LIMIT {$int_page_size} {$str_offset}", $arr_params);