Updated annotations. Added v4.4 support. Added missing return types. Fixed inheritance.

Author: stefanak-michal

README.md

@@ -1,7 +1,7 @@
 # Bolt
 Bolt protocol library over TCP socket. Bolt protocol is created and in use for communication with [Neo4j](https://neo4j.com/) Graph database. The documentation is available at [https://7687.org/](https://7687.org/). This library is aimed to be low level and keep up with protocol messages architecture and specifications.
 
-![](https://img.shields.io/badge/phpunit-passed-success) ![](https://img.shields.io/badge/coverage-87%25-green) ![](https://img.shields.io/github/stars/stefanak-michal/Bolt) ![](https://img.shields.io/packagist/dt/stefanak-michal/bolt) ![](https://img.shields.io/github/v/release/stefanak-michal/bolt) ![](https://img.shields.io/github/commits-since/stefanak-michal/bolt/latest)
+![](https://img.shields.io/badge/phpunit-passed-success) ![](https://img.shields.io/badge/coverage-86%25-green) ![](https://img.shields.io/github/stars/stefanak-michal/Bolt) ![](https://img.shields.io/packagist/dt/stefanak-michal/bolt) ![](https://img.shields.io/github/v/release/stefanak-michal/bolt) ![](https://img.shields.io/github/commits-since/stefanak-michal/bolt/latest)
 
 ## [Version support](https://github.com/stefanak-michal/Bolt/wiki/Version-support)
 ## [Requirements](https://github.com/stefanak-michal/Bolt/wiki/Requirements)

src/Bolt.php

@@ -389,17 +389,17 @@ public function __destruct()
     }
 
     /**
-     * fetch the current routing table, if the message specification allows it.
-     *
+     * Fetch the current routing table, if the message specification allows it.
      * @param array|null $routing
-     *
-     * @return array{rt: array{servers: list<array{addresses: list<string>, role: 'WRITE'|'READ'|'ROUTE'}>, ttl: int}}|null
+     * @return array|null
      */
     public function route(?array $routing = null): ?array
     {
-        if (!method_exists($this->protocol, 'route')) {
+        if (self::$debug)
+            echo 'ROUTE';
+
+        if (!method_exists($this->protocol, 'route'))
             return null;
-        }
 
         $routing = $routing ?? ['address' => $this->connection->getIp() . ':' . $this->connection->getPort()];
         return $this->protocol->route($routing);

src/protocol/V1.php

@@ -11,6 +11,7 @@
  *
  * @author Michal Stefanak
  * @link https://github.com/stefanak-michal/Bolt
+ * @see https://7687.org/bolt/bolt-protocol-message-specification-1.html
  * @package Bolt\protocol
  */
 class V1 extends AProtocol
@@ -48,7 +49,7 @@ public function init(...$args): array
      * @return array
      * @throws Exception
      */
-    public function run(...$args)
+    public function run(...$args): array
     {
         if (empty($args)) {
             throw new PackException('Wrong arguments count');
@@ -70,7 +71,7 @@ public function run(...$args)
      * @return array
      * @throws Exception
      */
-    public function pullAll(...$args)
+    public function pullAll(...$args): array
     {
         $this->write($this->packer->pack(0x3F));
 

src/protocol/V2.php

@@ -7,6 +7,7 @@
  *
  * @author Michal Stefanak
  * @link https://github.com/stefanak-michal/Bolt
+ * @see https://7687.org/bolt/bolt-protocol-message-specification-2.html
  * @package Bolt\protocol
  */
 class V2 extends V1

src/protocol/V3.php

@@ -11,6 +11,7 @@
  *
  * @author Michal Stefanak
  * @link https://github.com/stefanak-michal/Bolt
+ * @see https://7687.org/bolt/bolt-protocol-message-specification-3.html
  * @package Bolt\protocol
  */
 class V3 extends V2
@@ -53,11 +54,11 @@ public function hello(...$args): array
     }
 
     /**
-     * @param mixed ...$args
+     * @param string|array ...$args query, parameters, extra
      * @return array
      * @throws Exception
      */
-    public function run(...$args)
+    public function run(...$args): array
     {
         if (empty($args)) {
             throw new PackException('Wrong arguments count');

src/protocol/V4.php

@@ -10,27 +10,28 @@
  *
  * @author Michal Stefanak
  * @link https://github.com/stefanak-michal/Bolt
+ * @see https://7687.org/bolt/bolt-protocol-message-specification-4.html
  * @package Bolt\protocol
  */
 class V4 extends V3
 {
 
     /**
-     * @param mixed ...$args
+     * @param array ...$args
      * @return array
      * @throws Exception
      */
-    public function pullAll(...$args)
+    public function pullAll(...$args): array
     {
         return $this->pull(...$args);
     }
 
     /**
-     * @param mixed ...$args
+     * @param array ...$args
      * @return array
      * @throws Exception
      */
-    public function pull(...$args)
+    public function pull(...$args): array
     {
         $this->write($this->packer->pack(0x3F, $args[0]));
 

src/protocol/V4_1.php

@@ -11,6 +11,7 @@
  *
  * @author Michal Stefanak
  * @link https://github.com/stefanak-michal/Bolt
+ * @see https://7687.org/bolt/bolt-protocol-message-specification-4.html#version-41
  * @package Bolt\protocol
  */
 class V4_1 extends V4

src/protocol/V4_2.php

@@ -7,6 +7,7 @@
  *
  * @author Michal Stefanak
  * @link https://github.com/stefanak-michal/Bolt
+ * @see https://7687.org/bolt/bolt-protocol-message-specification-4.html#version-42
  * @package Bolt\protocol
  */
 class V4_2 extends V4_1

src/protocol/V4_3.php

@@ -10,10 +10,17 @@
  *
  * @author Michal Stefanak
  * @link https://github.com/neo4j-php/Bolt
+ * @see https://7687.org/bolt/bolt-protocol-message-specification-4.html#version-43
  * @package Bolt\protocol
  */
-class V4_3 extends V4_1
+class V4_3 extends V4_2
 {
+    /**
+     * @param array|string|null ...$args
+     * @return array
+     * @throws MessageException
+     * @throws PackException
+     */
     public function route(...$args): array
     {
         if (count($args) < 1) {

src/protocol/V4_4.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Bolt\protocol;
+
+/**
+ * Class Protocol version 4.4
+ *
+ * @author Michal Stefanak
+ * @link https://github.com/neo4j-php/Bolt
+ * @see https://7687.org/bolt/bolt-protocol-message-specification-4.html#version-44
+ * @package Bolt\protocol
+ */
+class V4_4 extends V4_3
+{
+
+}