Merge pull request #20 from stefanak-michal/extra_parameters

Extra parameters

Author: stefanak-michal

Bolt.php

@@ -191,18 +191,22 @@ private function packProtocolVersions(): string
      * @param string $name
      * @param string $user
      * @param string $password
+     * @param array $routing routing::Dictionary(address::String)
+     <pre>null - the server should not carry out routing
+     [] - the server should carry out routing
+     ['address' => 'ip:port'] - the server should carry out routing according to the given routing context</pre>
      * @return bool
      * @throws Exception
      */
-    public function init(string $name, string $user, string $password): bool
+    public function init(string $name, string $user, string $password, array $routing = null): bool
     {
         if (!$this->handshake())
             return false;
 
         if (self::$debug)
             echo 'INIT';
 
-        return $this->protocol->init($name, Bolt::$scheme, $user, $password);
+        return $this->protocol->init($name, Bolt::$scheme, $user, $password, $routing);
     }
 
     /**
@@ -212,19 +216,28 @@ public function init(string $name, string $user, string $password): bool
      * @param string $name
      * @param string $user
      * @param string $password
+     * @param array $routing routing::Dictionary(address::String)
+    <pre>null - the server should not carry out routing
+    [] - the server should carry out routing
+    ['address' => 'ip:port'] - the server should carry out routing according to the given routing context</pre>
      * @return bool
      * @throws Exception
      */
-    public function hello(string $name, string $user, string $password): bool
+    public function hello(string $name, string $user, string $password, array $routing = null): bool
     {
-        return $this->init($name, $user, $password);
+        return $this->init($name, $user, $password, $routing);
     }
 
     /**
      * Send RUN message
      * @param string $statement
      * @param array $parameters
-     * @param array $extra
+     * @param array $extra extra::Dictionary(bookmarks::List<String>, tx_timeout::Integer, tx_metadata::Dictionary, mode::String, db:String)
+    <pre>The bookmarks is a list of strings containg some kind of bookmark identification e.g [“neo4j-bookmark-transaction:1”, “neo4j-bookmark-transaction:2”]
+    The tx_timeout is an integer in that specifies a transaction timeout in ms.
+    The tx_metadata is a dictionary that can contain some metadata information, mainly used for logging.
+    The mode specifies what kind of server the RUN message is targeting. For write access use "w" and for read access use "r". Defaults to write access if no mode is sent.
+    The db specifies the database name for multi-database to select where the transaction takes place. If no db is sent or empty string it implies that it is the default database.</pre>
      * @return mixed Return false on error
      */
     public function run(string $statement, array $parameters = [], array $extra = [])
@@ -237,52 +250,65 @@ public function run(string $statement, array $parameters = [], array $extra = []
     /**
      * Send PULL_ALL message
      * @version <4
+     * @param int $n The n specifies how many records to fetch. n=-1 will fetch all records.
+     * @param int $qid The qid (query identification) specifies the result of which statement the operation should be carried out. (Explicit Transaction only). qid=-1 can be used to denote the last executed statement and if no ``.
      * @return mixed Array of records or false on error. Last array element is success message.
      */
-    public function pullAll()
+    public function pullAll(int $n = -1, int $qid = -1)
     {
         if (self::$debug)
             echo 'PULL';
-        return $this->protocol->pullAll();
+        return $this->protocol->pullAll(['n' => $n, 'qid' => $qid]);
     }
 
     /**
      * Send PULL message
      * @version >=4
      * @internal PULL_ALL alias
+     * @param int $n The n specifies how many records to fetch. n=-1 will fetch all records.
+     * @param int $qid The qid (query identification) specifies the result of which statement the operation should be carried out. (Explicit Transaction only). qid=-1 can be used to denote the last executed statement and if no ``.
      * @return mixed Array of records or false on error. Last array element is success message.
      */
-    public function pull()
+    public function pull(int $n = -1, int $qid = -1)
     {
-        return $this->pullAll();
+        return $this->pullAll($n, $qid);
     }
 
     /**
      * Send DISCARD_ALL message
      * @version <4
+     * @param int $n The n specifies how many records to throw away. n=-1 will throw away all records.
+     * @param int $qid The qid (query identification) specifies the result of which statement the operation should be carried out. (Explicit Transaction only). qid=-1 can be used to denote the last executed statement and if no ``.
      * @return bool
      */
-    public function discardAll()
+    public function discardAll(int $n = -1, int $qid = -1)
     {
         if (self::$debug)
             echo 'DISCARD';
-        return $this->protocol->discardAll();
+        return $this->protocol->discardAll(['n' => $n, 'qid' => $qid]);
     }
 
     /**
      * Send DISCARD message
      * @version >=4
      * @internal DISCARD_ALL alias
+     * @param int $n The n specifies how many records to throw away. n=-1 will throw away all records.
+     * @param int $qid The qid (query identification) specifies the result of which statement the operation should be carried out. (Explicit Transaction only). qid=-1 can be used to denote the last executed statement and if no ``.
      * @return bool
      */
-    public function discard(): bool
+    public function discard(int $n = -1, int $qid = -1): bool
     {
-        return $this->discardAll();
+        return $this->discardAll($n, $qid);
     }
 
     /**
      * Send BEGIN message
-     * @param array $extra
+     * @param array $extra extra::Dictionary(bookmarks::List<String>, tx_timeout::Integer, tx_metadata::Dictionary, mode::String, db:String)
+    <pre>The bookmarks is a list of strings containg some kind of bookmark identification e.g [“neo4j-bookmark-transaction:1”, “neo4j-bookmark-transaction:2”]
+    The tx_timeout is an integer in that specifies a transaction timeout in ms.
+    The tx_metadata is a dictionary that can contain some metadata information, mainly used for logging.
+    The mode specifies what kind of server the RUN message is targeting. For write access use "w" and for read access use "r". Defaults to write access if no mode is sent.
+    The db specifies the database name for multi-database to select where the transaction takes place. If no db is sent or empty string it implies that it is the default database.</pre>
      * @return bool
      */
     public function begin(array $extra = []): bool

index.php

@@ -51,6 +51,12 @@
     $neo4jVersion = $bolt->pull()[0][0] ?? '';
     $t = version_compare($neo4jVersion, '4') == -1;
 
+    //test discard
+    $bolt->run('MATCH (a:Test) RETURN *');
+    if (!$bolt->discard()) {
+        throw new Exception('Discard failed');
+    }
+
     //test delete created node
     $bolt->run('MATCH (a:Test) WHERE ID(a) = ' . ($t ? '{a}' : '$a') . ' DELETE a', [
         'a' => $created[0][1]

protocol/V4.php

@@ -23,12 +23,8 @@ public function pullAll(...$args)
 
     public function pull(...$args)
     {
-        if (empty($args)) {
-            $args[0]['n'] = -1;
-        }
-
         try {
-            $msg = $this->packer->pack(0x3F, (object)($args[0] ?? []));
+            $msg = $this->packer->pack(0x3F, $args[0]);
         } catch (Exception $ex) {
             Bolt::error($ex->getMessage());
             return false;
@@ -59,7 +55,7 @@ public function discardAll(...$args): bool
     public function discard(...$args): bool
     {
         try {
-            $msg = $this->packer->pack(0x2F, $args[0] ?? []);
+            $msg = $this->packer->pack(0x2F, $args[0]);
         } catch (Exception $ex) {
             Bolt::error($ex->getMessage());
             return false;

protocol/V4_1.php

@@ -18,7 +18,7 @@ class V4_1 extends V4
 
     public function hello(...$args): bool
     {
-        if (count($args) < 4) {
+        if (count($args) != 5) {
             Bolt::error('Wrong arguments count');
             return false;
         }
@@ -29,7 +29,7 @@ public function hello(...$args): bool
                 'scheme' => $args[1],
                 'principal' => $args[2],
                 'credentials' => $args[3],
-                'routing' => (object)($args[4] ?? [])
+                'routing' => is_array($args[4]) ? (object)$args[4] : null
             ]);
         } catch (Exception $ex) {
             Bolt::error($ex->getMessage());