Merge pull request #107 from neo4j-php/php8

Php8

Author: stefanak-michal

README.md

@@ -15,15 +15,15 @@ PHP library for communication with graph database over TCP socket with Bolt prot
 
 ## Version support
 
-We are trying to keep up and this library supports **Neo4j <= 5.2** with **Bolt <= 5.2**.
+We are trying to keep up and this library supports **Neo4j <= 5.2** with **Bolt <= 5.0**.
 
 https://www.neo4j.com/docs/bolt/current/bolt-compatibility/
 
 ## Requirements
 
-Keep up with [PHP supported versions](https://www.php.net/supported-versions.php) means we are at **PHP >= 7.4**.
+Keep up with [PHP supported versions](https://www.php.net/supported-versions.php) means we are at **PHP >= 8.0**.
 
-_If you need support for PHP < 7.4 you can use latest v3.x release. Not all new features are implement backwards and this readme is updated to latest released version._
+_If you need support for PHP < 7.4 you can use latest v3.x release and if you need support for PHP 7.4 you can use v5.x. Not all new features are implement backwards and this readme is updated to latest released version._
 
 ### Extensions
 

composer.json

@@ -8,7 +8,7 @@
     "license": "MIT",
     "minimum-stability": "stable",
     "require": {
-        "php": ">=7.4",
+        "php": ">=8",
         "ext-mbstring": "*"
     },
     "require-dev": {

src/Bolt.php

@@ -2,9 +2,8 @@
 
 namespace Bolt;
 
-use Bolt\error\{ConnectException, PackException, UnpackException};
-use Exception;
-use Bolt\packstream\{IPacker, IUnpacker};
+use Bolt\error\ConnectException;
+use Bolt\error\BoltException;
 use Bolt\protocol\{AProtocol, ServerState};
 use Bolt\connection\IConnection;
 
@@ -19,29 +18,20 @@
  */
 final class Bolt
 {
-    private IPacker $packer;
-    private IUnpacker $unpacker;
-    private IConnection $connection;
-    private array $versions = [];
+    private array $protocolVersions = [];
+    private int $packStreamVersion = 1;
+
     public static bool $debug = false;
     public ServerState $serverState;
 
-    /**
-     * Bolt constructor
-     * @param IConnection $connection
-     * @throws Exception
-     */
-    public function __construct(IConnection $connection)
+    public function __construct(private IConnection $connection)
     {
-        $this->connection = $connection;
         $this->setProtocolVersions(5, 4.4, 4.3);
-        $this->setPackStreamVersion();
     }
 
     /**
      * Connect via Connection, execute handshake on it, create and return protocol version class
-     * @return AProtocol
-     * @throws Exception
+     * @throws BoltException
      */
     public function build(): AProtocol
     {
@@ -65,47 +55,32 @@ public function build(): AProtocol
         }
 
         $this->serverState->set(ServerState::CONNECTED);
-        return new $protocolClass($this->packer, $this->unpacker, $this->connection, $this->serverState);
+        return new $protocolClass($this->packStreamVersion, $this->connection, $this->serverState);
     }
 
-    /**
-     * @param int|float|string ...$v
-     * @return Bolt
-     */
-    public function setProtocolVersions(...$v): Bolt
+    public function setProtocolVersions(int|float|string ...$v): Bolt
     {
-        $this->versions = array_slice($v, 0, 4);
-        while (count($this->versions) < 4)
-            $this->versions[] = 0;
+        $this->protocolVersions = array_slice($v, 0, 4);
+        while (count($this->protocolVersions) < 4)
+            $this->protocolVersions[] = 0;
         return $this;
     }
 
-    /**
-     * @param int $version
-     * @return Bolt
-     * @throws Exception
-     */
     public function setPackStreamVersion(int $version = 1): Bolt
     {
-        $packerClass = "\\Bolt\\packstream\\v" . $version . "\\Packer";
-        if (!class_exists($packerClass)) {
-            throw new PackException('Requested PackStream version (' . $version . ') not yet implemented');
-        }
-        $this->packer = new $packerClass();
-
-        $unpackerClass = "\\Bolt\\packstream\\v" . $version . "\\Unpacker";
-        if (!class_exists($unpackerClass)) {
-            throw new UnpackException('Requested PackStream version (' . $version . ') not yet implemented');
-        }
-        $this->unpacker = new $unpackerClass();
+        $this->packStreamVersion = $version;
+        return $this;
+    }
 
+    public function setConnection(IConnection $connection): Bolt
+    {
+        $this->connection = $connection;
         return $this;
     }
 
     /**
      * @link https://www.neo4j.com/docs/bolt/current/bolt/handshake/
-     * @return string
-     * @throws Exception
+     * @throws BoltException
      */
     private function handshake(): string
     {
@@ -126,8 +101,6 @@ private function handshake(): string
 
     /**
      * Read and compose selected protocol version
-     * @param string $bytes
-     * @return string|null
      */
     private function unpackProtocolVersion(string $bytes): ?string
     {
@@ -142,18 +115,17 @@ private function unpackProtocolVersion(string $bytes): ?string
         }
 
         $version = implode('.', array_reverse($result));
-        return in_array($version, $this->versions) ? $version : null;
+        return in_array($version, $this->protocolVersions) ? $version : null;
     }
 
     /**
      * Pack requested protocol versions
-     * @return string
      */
     private function packProtocolVersions(): string
     {
         $versions = [];
 
-        foreach ($this->versions as $v) {
+        foreach ($this->protocolVersions as $v) {
             if (is_int($v))
                 $versions[] = pack('N', $v);
             else {

src/autoload.php

@@ -1,6 +1,6 @@
 <?php
 
-define('DS', DIRECTORY_SEPARATOR);
+const DS = DIRECTORY_SEPARATOR;
 
 spl_autoload_register(function ($name) {
     $parts = explode("\\", $name);

src/connection/AConnection.php

@@ -11,33 +11,24 @@
  */
 abstract class AConnection implements IConnection
 {
-    protected string $ip;
-    protected int $port;
-    protected float $timeout;
-
-    /**
-     * @inheritDoc
-     */
-    public function __construct(string $ip = '127.0.0.1', int $port = 7687, float $timeout = 15)
+    public function __construct(
+        protected string $ip = '127.0.0.1',
+        protected int    $port = 7687,
+        protected float  $timeout = 15
+    )
     {
-        if (filter_var($ip, FILTER_VALIDATE_URL)) {
-            $scheme = parse_url($ip, PHP_URL_SCHEME);
+        if (filter_var($this->ip, FILTER_VALIDATE_URL)) {
+            $scheme = parse_url($this->ip, PHP_URL_SCHEME);
             if (!empty($scheme)) {
-                $ip = str_replace($scheme . '://', '', $ip);
+                $this->ip = str_replace($scheme . '://', '', $this->ip);
             }
         }
-
-        $this->ip = $ip;
-        $this->port = $port;
-        $this->timeout = $timeout;
     }
 
     /**
      * Print buffer as HEX
-     * @param string $str
-     * @param string $prefix
      */
-    protected function printHex(string $str, string $prefix = 'C: ')
+    protected function printHex(string $str, string $prefix = 'C: '): void
     {
         $str = implode(unpack('H*', $str));
         echo '<pre>' . $prefix;
@@ -63,7 +54,7 @@ public function getTimeout(): float
         return $this->timeout;
     }
 
-    public function setTimeout(float $timeout)
+    public function setTimeout(float $timeout): void
     {
         $this->timeout = $timeout;
     }

src/connection/IConnection.php

@@ -2,6 +2,8 @@
 
 namespace Bolt\connection;
 
+use Bolt\error\ConnectException;
+
 /**
  * Interface IConnection
  *
@@ -11,26 +13,30 @@
  */
 interface IConnection
 {
-    /**
-     * @param string $ip
-     * @param int $port
-     * @param float $timeout
-     */
     public function __construct(string $ip = '127.0.0.1', int $port = 7687, float $timeout = 15);
 
+    /**
+     * @throws ConnectException
+     */
     public function connect(): bool;
 
-    public function write(string $buffer);
+    /**
+     * @throws ConnectException
+     */
+    public function write(string $buffer): void;
 
+    /**
+     * @throws ConnectException
+     */
     public function read(int $length = 2048): string;
 
-    public function disconnect();
+    public function disconnect(): void;
 
     public function getIp(): string;
 
     public function getPort(): int;
 
     public function getTimeout(): float;
 
-    public function setTimeout(float $timeout);
+    public function setTimeout(float $timeout): void;
 }

src/connection/Socket.php

@@ -16,17 +16,12 @@
 class Socket extends AConnection
 {
     /**
-     * @var resource|object|bool
+     * @var resource|\Socket|bool
      */
     private $socket = false;
 
     private const POSSIBLE_TIMEOUTS_CODES = [11, 10060];
 
-    /**
-     * Create socket connection
-     * @return bool
-     * @throws ConnectException
-     */
     public function connect(): bool
     {
         if (!extension_loaded('sockets')) {
@@ -55,12 +50,7 @@ public function connect(): bool
         return true;
     }
 
-    /**
-     * Write buffer to socket
-     * @param string $buffer
-     * @throws ConnectException
-     */
-    public function write(string $buffer)
+    public function write(string $buffer): void
     {
         if ($this->socket === false) {
             throw new ConnectException('Not initialized socket');
@@ -79,20 +69,14 @@ public function write(string $buffer)
         }
     }
 
-    /**
-     * Read buffer from socket
-     * @param int $length
-     * @return string
-     * @throws ConnectException
-     */
     public function read(int $length = 2048): string
     {
         if ($this->socket === false)
             throw new ConnectException('Not initialized socket');
 
         $output = '';
         do {
-            $readed = @socket_read($this->socket, $length - mb_strlen($output, '8bit'), PHP_BINARY_READ);
+            $readed = @socket_read($this->socket, $length - mb_strlen($output, '8bit'));
             if ($readed === false)
                 $this->throwConnectException();
             $output .= $readed;
@@ -104,24 +88,21 @@ public function read(int $length = 2048): string
         return $output;
     }
 
-    /**
-     * Close socket connection
-     */
-    public function disconnect()
+    public function disconnect(): void
     {
         if ($this->socket !== false) {
             @socket_shutdown($this->socket);
             @socket_close($this->socket);
         }
     }
 
-    public function setTimeout(float $timeout)
+    public function setTimeout(float $timeout): void
     {
         parent::setTimeout($timeout);
         $this->configureTimeout();
     }
 
-    private function configureTimeout()
+    private function configureTimeout(): void
     {
         if ($this->socket === false)
             return;