Merge pull request #40 from stefanak-michal/issue/24_remove_error_handler

Issue/24 remove error handler

Author: stefanak-michal

README.md

@@ -1,7 +1,7 @@
 # Bolt
 Bolt protocol library over TCP socket. Bolt protocol is primary used for communication with [Neo4j](https://neo4j.com/) Graph database. The documentation is available at [https://7687.org/](https://7687.org/).
 
-![](https://img.shields.io/badge/phpunit-passed-success) ![](https://img.shields.io/badge/coverage-77%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
 Bolt <= 4.1

src/Bolt.php

@@ -2,6 +2,11 @@
 
 namespace Bolt;
 
+use Bolt\error\{
+    ConnectException,
+    PackException,
+    UnpackException
+};
 use Exception;
 use Bolt\PackStream\{IPacker, IUnpacker};
 use Bolt\protocol\AProtocol;
@@ -47,22 +52,11 @@ final class Bolt
      */
     private $version;
 
-    /**
-     * @var int
-     */
-    private $packStreamVersion = 1;
-
     /**
      * @var string
      */
     private $scheme = 'basic';
 
-    /**
-     * Custom error handler instead of throwing Exceptions
-     * @var callable (string message, string code)
-     */
-    public static $errorHandler;
-    
     /**
      * Print debug info
      * @var bool 
@@ -77,20 +71,7 @@ final class Bolt
     public function __construct(IConnection $connection)
     {
         $this->connection = $connection;
-
-        $packerClass = "\\Bolt\\PackStream\\v" . $this->packStreamVersion . "\\Packer";
-        if (!class_exists($packerClass)) {
-            Bolt::error('Requested PackStream version (' . $this->packStreamVersion . ') not yet implemented');
-        } else {
-            $this->packer = new $packerClass();
-        }
-
-        $unpackerClass = "\\Bolt\\PackStream\\v" . $this->packStreamVersion . "\\Unpacker";
-        if (!class_exists($unpackerClass)) {
-            Bolt::error('Requested PackStream version (' . $this->packStreamVersion . ') not yet implemented');
-        } else {
-            $this->unpacker = new $unpackerClass();
-        }
+        $this->setPackStreamVersion();
     }
 
     /**
@@ -106,10 +87,22 @@ public function setProtocolVersions(...$v): Bolt
     /**
      * @param int $version
      * @return Bolt
+     * @throws Exception
      */
     public function setPackStreamVersion(int $version = 1)
     {
-        $this->packStreamVersion = $version;
+        $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();
+
         return $this;
     }
 
@@ -146,16 +139,14 @@ private function handshake(): bool
 
         $this->unpackProtocolVersion();
         if (empty($this->version)) {
-            Bolt::error('Wrong version');
-            return false;
+            throw new ConnectException('Wrong version');
         }
 
         $protocolClass = "\\Bolt\\protocol\\V" . str_replace('.', '_', $this->version);
         if (!class_exists($protocolClass)) {
-            Bolt::error('Requested Protocol version (' . $this->version . ') not yet implemented');
-        } else {
-            $this->protocol = new $protocolClass($this->packer, $this->unpacker, $this->connection);
+            throw new ConnectException('Requested Protocol version (' . $this->version . ') not yet implemented');
         }
+        $this->protocol = new $protocolClass($this->packer, $this->unpacker, $this->connection);
 
         return $this->protocol instanceof AProtocol;
     }
@@ -258,7 +249,8 @@ public function hello(string $name, string $user, string $password, array $routi
     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
+     * @return array
+     * @throws Exception
      */
     public function run(string $statement, array $parameters = [], array $extra = [])
     {
@@ -272,7 +264,8 @@ public function run(string $statement, array $parameters = [], array $extra = []
      * @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.
+     * @return array
+     * @throws Exception
      */
     public function pullAll(int $n = -1, int $qid = -1)
     {
@@ -287,7 +280,8 @@ public function pullAll(int $n = -1, int $qid = -1)
      * @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.
+     * @return array Array of records. Last array element is success message.
+     * @throws Exception
      */
     public function pull(int $n = -1, int $qid = -1)
     {
@@ -300,6 +294,7 @@ public function pull(int $n = -1, int $qid = -1)
      * @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
+     * @throws Exception
      */
     public function discardAll(int $n = -1, int $qid = -1)
     {
@@ -315,6 +310,7 @@ public function discardAll(int $n = -1, int $qid = -1)
      * @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
+     * @throws Exception
      */
     public function discard(int $n = -1, int $qid = -1): bool
     {
@@ -330,6 +326,7 @@ public function discard(int $n = -1, int $qid = -1): bool
     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
+     * @throws Exception
      */
     public function begin(array $extra = []): bool
     {
@@ -341,6 +338,7 @@ public function begin(array $extra = []): bool
     /**
      * Send COMMIT message
      * @return bool
+     * @throws Exception
      */
     public function commit(): bool
     {
@@ -352,6 +350,7 @@ public function commit(): bool
     /**
      * Send ROLLBACK message
      * @return bool
+     * @throws Exception
      */
     public function rollback(): bool
     {
@@ -363,6 +362,7 @@ public function rollback(): bool
     /**
      * Send RESET message
      * @return bool
+     * @throws Exception
      */
     public function reset(): bool
     {
@@ -371,24 +371,6 @@ public function reset(): bool
         return $this->protocol->reset();
     }
 
-    /**
-     * Process error
-     * @param string $msg
-     * @param string $code
-     * @throws Exception
-     */
-    public static function error(string $msg, string $code = '')
-    {
-        if (is_callable(self::$errorHandler)) {
-            call_user_func(self::$errorHandler, $msg, $code);
-        } else {
-            if (!empty($code)) {
-                $msg .= ' (' . $code . ')';
-            }
-            throw new Exception($msg);
-        }
-    }
-
     /**
      * Say goodbye
      */

src/PackStream/v1/Packer.php

@@ -2,8 +2,8 @@
 
 namespace Bolt\PackStream\v1;
 
-use Exception;
 use Bolt\PackStream\IPacker;
+use Bolt\error\PackException;
 
 /**
  * Class Packer of PackStream version 1
@@ -24,7 +24,7 @@ class Packer implements IPacker
      * @param $signature
      * @param mixed ...$params
      * @return string
-     * @throws Exception
+     * @throws PackException
      */
     public function pack($signature, ...$params): string
     {
@@ -39,7 +39,7 @@ public function pack($signature, ...$params): string
         } elseif ($length < self::LARGE) { //STRUCT_16
             $output .= chr(0xDD) . pack('n', $length);
         } else {
-            throw new Exception('Too many parameters');
+            throw new PackException('Too many parameters');
         }
 
         $output .= chr($signature);
@@ -55,7 +55,7 @@ public function pack($signature, ...$params): string
     /**
      * @param mixed $param
      * @return string
-     * @throws Exception
+     * @throws PackException
      */
     private function p($param): string
     {
@@ -80,7 +80,7 @@ private function p($param): string
         } elseif (is_object($param)) {
             $output .= $this->packMap((array)$param);
         } else {
-            throw new Exception('Not recognized type of parameter');
+            throw new PackException('Not recognized type of parameter');
         }
 
         return $output;
@@ -89,7 +89,7 @@ private function p($param): string
     /**
      * @param string $str
      * @return string
-     * @throws Exception
+     * @throws PackException
      */
     private function packString(string $str): string
     {
@@ -105,7 +105,7 @@ private function packString(string $str): string
         } elseif ($length < self::HUGE) { //STRING_32
             $output .= chr(0xD2) . pack('N', $length) . $str;
         } else {
-            throw new Exception('String too long');
+            throw new PackException('String too long');
         }
 
         return $output;
@@ -123,7 +123,7 @@ private function packFloat(float $value): string
     /**
      * @param int $value
      * @return string
-     * @throws Exception
+     * @throws PackException
      */
     private function packInteger(int $value): string
     {
@@ -150,7 +150,7 @@ private function packInteger(int $value): string
             $packed = pack('q', $value);
             $output .= chr(0xCB) . ($little ? strrev($packed) : $packed);
         } else {
-            throw new Exception('Integer out of range');
+            throw new PackException('Integer out of range');
         }
 
         return $output;
@@ -159,7 +159,7 @@ private function packInteger(int $value): string
     /**
      * @param array $arr
      * @return string
-     * @throws Exception
+     * @throws PackException
      */
     private function packMap(array $arr): string
     {
@@ -175,7 +175,7 @@ private function packMap(array $arr): string
         } elseif ($size < self::HUGE) { //MAP_32
             $output .= chr(0xDA) . pack('N', $size);
         } else {
-            throw new Exception('Too many map elements');
+            throw new PackException('Too many map elements');
         }
 
         foreach ($arr as $k => $v) {
@@ -189,7 +189,7 @@ private function packMap(array $arr): string
     /**
      * @param array $arr
      * @return string
-     * @throws Exception
+     * @throws PackException
      */
     private function packList(array $arr): string
     {
@@ -205,7 +205,7 @@ private function packList(array $arr): string
         } elseif ($size < self::HUGE) { //LIST_32
             $output .= chr(0xD6) . pack('N', $size);
         } else {
-            throw new Exception('Too many list elements');
+            throw new PackException('Too many list elements');
         }
 
         foreach ($arr as $v) {