Added cursor options to get return values as an array instead of json

martin-schilling · martin-schilling · commit 88dde8453ceb · 2017-11-23T23:39:17.000+01:00
diff --git a/src/connection.cpp b/src/connection.cpp
@@ -238,6 +238,11 @@ namespace arangodb { namespace fuerte { namespace php {
             throw Php::Exception("Expected vpack to be of type Vpack");
 
         Cursor* cursor = new Cursor(this, (Vpack*)params[0].implementation());
+
+        for(auto option : params[1]) {
+            cursor->setOption(option.first, option.second);
+        }
+
         return Php::Object("ArangoDb\\Cursor", cursor);
     }
 
diff --git a/src/cursor.cpp b/src/cursor.cpp
@@ -7,6 +7,15 @@ namespace arangodb { namespace fuerte { namespace php {
         this->loadFirstBatch();
     }
 
+    void Cursor::setOption(int option, int value)
+    {
+        if(this->options.size() <= option) {
+            throw Php::Exception("Invalid option provided for Cursor");
+        }
+
+        this->options[option] = value;
+    }
+
     void Cursor::loadFirstBatch()
     {
         Request request("/_api/cursor", this->vpack);
@@ -82,7 +91,16 @@ namespace arangodb { namespace fuerte { namespace php {
             throw Php::Exception(e.what());
         }
 
-        return body;
+        switch(this->options[Cursor::ENTRY_TYPE]) {
+            case Cursor::ENTRY_TYPE_JSON:
+                return body;
+            case Cursor::ENTRY_TYPE_ARRAY:
+                return Php::call("json_decode", body, true);
+            case Cursor::ENTRY_TYPE_OBJECT:
+                return Php::call("json_decode", body, false);
+            default:
+                return body;
+        }
     }
 
     Php::Value Cursor::key()
diff --git a/src/cursor.h b/src/cursor.h
@@ -30,9 +30,21 @@ namespace arangodb { namespace fuerte { namespace php {
         void loadFirstBatch();
         void loadMore();
 
+        std::vector<int> options = {
+            { Cursor::ENTRY_TYPE, Cursor::ENTRY_TYPE_JSON }
+        };
+
     public:
+        static const int ENTRY_TYPE = 0;
+
+        static const int ENTRY_TYPE_JSON = 100;
+        static const int ENTRY_TYPE_ARRAY = 101;
+        static const int ENTRY_TYPE_OBJECT = 102;
+
         Cursor(Connection* connection, Vpack* vpack);
 
+        void setOption(int option, int value);
+
         virtual long count() override;
         Php::Value getCount();
 
diff --git a/src/main.cpp b/src/main.cpp
@@ -75,7 +75,10 @@ extern "C" {
 
         connection.method<&arangodb::fuerte::php::Connection::wait>("wait");
 
-        connection.method<&arangodb::fuerte::php::Connection::query>("query");
+        connection.method<&arangodb::fuerte::php::Connection::query>("query", {
+            Php::ByVal("vpack", "ArangoDb\\Vpack", true),
+            Php::ByVal("options", Php::Type::Array, false)
+        });
 
         connection.property("HOST", "host", Php::Const);
         connection.property("USER", "user", Php::Const);
@@ -153,6 +156,11 @@ extern "C" {
         cursor.method<&arangodb::fuerte::php::Cursor::rewind>("rewind");
         cursor.method<&arangodb::fuerte::php::Cursor::getCount>("count");
 
+        cursor.property("ENTRY_TYPE", arangodb::fuerte::php::Cursor::ENTRY_TYPE, Php::Const);
+        cursor.property("ENTRY_TYPE_JSON", arangodb::fuerte::php::Cursor::ENTRY_TYPE_JSON, Php::Const);
+        cursor.property("ENTRY_TYPE_ARRAY", arangodb::fuerte::php::Cursor::ENTRY_TYPE_ARRAY, Php::Const);
+        cursor.property("ENTRY_TYPE_OBJECT", arangodb::fuerte::php::Cursor::ENTRY_TYPE_OBJECT, Php::Const);
+
         extension->add(std::move(cursor));
     }
 }
diff --git a/tests/ConnectionTest.php b/tests/ConnectionTest.php
@@ -7,6 +7,7 @@
 use PHPUnit\Framework\TestCase;
 use ArangoDb\Connection;
 use ArangoDb\Vpack;
+use ArangoDb\Cursor;
 
 /**
  * @group connection
@@ -195,4 +196,33 @@ public function it_sends_query_with_bind_params()
 
         $this->assertSame(3, $iterations);
     }
+
+    /**
+     * @test
+     */
+    public function it_sends_query_and_returns_result_as_array()
+    {
+        $this->connection = TestUtil::getConnection();
+
+        $cursor = $this->connection->query(
+            Vpack::fromArray([
+                'query' => 'FOR i IN 1..100 RETURN [i, i+1]',
+                'batchSize' => 10
+            ]), [
+                Cursor::ENTRY_TYPE => Cursor::ENTRY_TYPE_ARRAY
+            ]
+        );
+
+        $cursor->rewind();
+        $iterations = 0;
+
+        while ($cursor->valid()) {
+            $data = $cursor->current();
+            $this->assertArrayHasKey(0, $data);
+            $iterations++;
+            $cursor->next();
+        }
+
+        $this->assertSame(100, $iterations);
+    }
 }
