Add QueryOptions class

Add getId() and getState() methods to Query class
Miscellaneous bugfixes

Author: Matthew Wiltzius

src/Query.php

@@ -33,16 +33,16 @@ class Query
     private int        $rows           = 100;
     private ?string    $correlationId  = null;
 
-    public function __construct(SQLJob $job, string $sql, ?array $options)
+    public function __construct(SQLJob $job, string $sql, ?QueryOptions $options)
     {
         $this->job            = $job;
         $this->sql            = $sql;
 
         $options = $options ?? [];
-        $this->parameters     = $options['parameters'] ?? [];
-        $this->isPrepared     = !empty($options['parameters']);
-        $this->isClCommand    = $options['isClCommand'] ?? false;
-        $this->isTerseResults = $options['isTerseResults'] ?? false;
+        $this->parameters     = $options->parameters ?? [];
+        $this->isPrepared     = !empty($options->parameters);
+        $this->isClCommand    = $options->isClCommand ?? false;
+        $this->isTerseResults = $options->isTerseResults ?? false;
 
         self::$globalQueryList[] = $this;
     }
@@ -86,7 +86,7 @@ public function prepareSqlExecute(): array
             }
             if (count($errorList) == 0)
                 $errorList['error'] = "failed to run query for unknown reason";
-            throw new \RunetimeException(json_encode($errorList));
+            throw new \RuntimeException(json_encode($errorList));
         }
 
         $isDone = (bool)($results['is_done'] ?? false);
@@ -97,7 +97,7 @@ public function prepareSqlExecute(): array
         return $results;
     }
 
-    public function run(int $rows = null): array
+    public function run(?int $rows = null): array
     {
         if ($rows == null)
             $rows = $this->rows;
@@ -128,7 +128,7 @@ public function run(int $rows = null): array
                 'parameters' => $this->parameters,
             ];
 
-        $results = executeQuery($queryObject);
+        $results = $this->executeQuery($queryObject);
 
         $success = (bool)($results['success'] ?? false);
         if (!$success && !$this->isClCommand) {
@@ -141,7 +141,7 @@ public function run(int $rows = null): array
             }
             if (count($errorList) == 0)
                 $errorList['error'] = "failed to run query for unknown reason";
-            throw new \RunetimeException(json_encode($errorList));
+            throw new \RuntimeException(json_encode($errorList));
         }
 
         $isDone = (bool)($results['is_done'] ?? false);
@@ -174,12 +174,12 @@ public function fetchMore(int $rows): array
         ];
 
         $this->rows = $rows;
-        $results = executeQuery($queryObject);
+        $results = $this->executeQuery($queryObject);
 
         $success = (bool)($results['success'] ?? false);
         if (!$success && !$this->isClCommand) {
             $this->state = QueryState::ERROR;
-            throw new \RunetimeException(($results['error'] ?? "Failed to run Query (unknown error)"));
+            throw new \RuntimeException(($results['error'] ?? "Failed to run Query (unknown error)"));
         }
 
         $isDone = (bool)($results['is_done'] ?? false);
@@ -204,4 +204,14 @@ public function close(): array
         elseif (!$this->correlationId)
             $this->state = QueryState::RUN_DONE;
     }
+
+    public function getId(): string
+    {
+      return $this->correlationId;
+    }
+
+    public function getState(): QueryState
+    {
+      return $this->state;
+    }
 }

src/QueryOptions.php

@@ -0,0 +1,30 @@
+<?php declare(strict_types=1);
+
+/*
+ * Copyright 2024 IBM
+ * All Rights Reserved
+ * Apache License 2.0 ... see LICENSE file
+ * 
+ * Original Author: Matthew Wiltzius <[email protected]>
+ */
+
+namespace Mapepire;
+
+final class QueryOptions
+{
+    public ?bool  $isTerseResults = null;
+    public ?bool  $isClCommand    = null;
+    public ?array $parameters     = null;
+    public ?bool  $autoClose      = null;
+
+    public function __construct(?array $data = null) {
+        $this->isTerseResults = isset($data['isTerseResults']) ? (bool)$data['isTerseResults'] : null;
+        $this->isClCommand    = isset($data['isClCommand'])    ? (bool)$data['isClCommand']    : null;
+        $this->parameters     = isset($data['parameters'])     ? array_values((array)$data['parameters']) : null;
+        $this->autoClose      = isset($data['autoClose'])      ? (bool)$data['autoClose']      : null;
+    }
+
+    public function test() {
+      print("We're using the correct one!");
+    }
+}

src/SQLJob.php

@@ -203,9 +203,12 @@ public function close(): void
         }
     }
 
-    public function query(string $sql, ?array $options = null): Query
+    public function query(string $sql, QueryOptions|array|null $options = null): Query
     {
-        return new Query($this, $sql, null);
+        if(is_array($options)) {
+            $options = new QueryOptions($options);
+        }
+        return new Query($this, $sql, $options);
     }
 
     public function queryAndRun(string $sql): string