Merge pull request #54 from neo4j-php/init_success_metadata

populate init/hello success response metadata

Author: stefanak-michal

src/Bolt.php

@@ -203,10 +203,11 @@ private function packProtocolVersions(): 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>
+     * @param array $metadata Server success response metadata
      * @return bool
      * @throws Exception
      */
-    public function init(string $name, string $user, string $password, array $routing = null): bool
+    public function init(string $name, string $user, string $password, array $routing = null, array &$metadata = []): bool
     {
         if (!$this->connection->connect())
             return false;
@@ -217,7 +218,8 @@ public function init(string $name, string $user, string $password, array $routin
         if (self::$debug)
             echo 'INIT';
 
-        return $this->protocol->init($name, $this->scheme, $user, $password, $routing);
+        $metadata = $this->protocol->init($name, $this->scheme, $user, $password, $routing);
+        return !empty($metadata);
     }
 
     /**

src/protocol/IProtocol.php

@@ -15,9 +15,9 @@ interface IProtocol
     /**
      * Send INIT/HELLO message
      * @param mixed ...$args
-     * @return bool
+     * @return array
      */
-    public function init(...$args): bool;
+    public function init(...$args): array;
 
     /**
      * Send RUN message

src/protocol/V1.php

@@ -18,10 +18,10 @@ class V1 extends AProtocol
 
     /**
      * @param mixed ...$args
-     * @return bool
+     * @return array
      * @throws Exception
      */
-    public function init(...$args): bool
+    public function init(...$args): array
     {
         if (count($args) < 4) {
             throw new PackException('Wrong arguments count');
@@ -40,7 +40,7 @@ public function init(...$args): bool
             throw new MessageException($output['message'] . ' (' . $output['code'] . ')');
         }
 
-        return $signature == self::SUCCESS;
+        return $signature == self::SUCCESS ? $output : [];
     }
 
     /**

src/protocol/V3.php

@@ -18,26 +18,26 @@ class V3 extends V2
 
     /**
      * @param mixed ...$args
-     * @return bool
+     * @return array
      * @throws Exception
      */
-    public function init(...$args): bool
+    public function init(...$args): array
     {
         return $this->hello(...$args);
     }
 
     /**
      * @param mixed ...$args
-     * @return bool
+     * @return array
      * @throws Exception
      */
-    public function hello(...$args): bool
+    public function hello(...$args): array
     {
         if (count($args) < 4) {
             throw new PackException('Wrong arguments count');
         }
 
-        $this->write($msg = $this->packer->pack(0x01, [
+        $this->write($this->packer->pack(0x01, [
             'user_agent' => $args[0],
             'scheme' => $args[1],
             'principal' => $args[2],
@@ -49,7 +49,7 @@ public function hello(...$args): bool
             throw new MessageException($output['message'] . ' (' . $output['code'] . ')');
         }
 
-        return $signature == self::SUCCESS;
+        return $signature == self::SUCCESS ? $output : [];
     }
 
     /**

src/protocol/V4_1.php

@@ -18,10 +18,10 @@ class V4_1 extends V4
 
     /**
      * @param mixed ...$args
-     * @return bool
+     * @return array
      * @throws Exception
      */
-    public function hello(...$args): bool
+    public function hello(...$args): array
     {
         if (count($args) < 5) {
             throw new PackException('Wrong arguments count');
@@ -42,7 +42,7 @@ public function hello(...$args): bool
             throw new MessageException($output['message'] . ' (' . $output['code'] . ')');
         }
 
-        return $signature == self::SUCCESS;
+        return $signature == self::SUCCESS ? $output : [];
     }
 
 }