Introduce domain exceptions for decoding and encoding

Author: alcaeus

src/Codec/DecodeIfSupported.php

@@ -2,6 +2,8 @@
 
 namespace MongoDB\Codec;
 
+use MongoDB\Exception\UndecodableValueException;
+
 /**
  * @psalm-template BSONType
  * @psalm-template NativeType
@@ -19,6 +21,7 @@ abstract public function canDecode($value): bool;
      * @psalm-param BSONType $value
      * @return mixed
      * @psalm-return NativeType
+     * @throws UndecodableValueException if the decoder does not support the value
      */
     abstract public function decode($value);
 

src/Codec/Decoder.php

@@ -2,7 +2,7 @@
 
 namespace MongoDB\Codec;
 
-use MongoDB\Exception\InvalidArgumentException;
+use MongoDB\Exception\UndecodableValueException;
 
 /**
  * @psalm-template BSONType
@@ -26,7 +26,7 @@ public function canDecode($value): bool;
      * @psalm-param BSONType $value
      * @return mixed
      * @psalm-return NativeType
-     * @throws InvalidArgumentException if the decoder does not support the value
+     * @throws UndecodableValueException if the decoder does not support the value
      */
     public function decode($value);
 

src/Codec/DocumentCodec.php

@@ -3,6 +3,8 @@
 namespace MongoDB\Codec;
 
 use MongoDB\BSON\Document;
+use MongoDB\Exception\UndecodableValueException;
+use MongoDB\Exception\UnencodableValueException;
 
 /**
  * The DocumentCodec interface allows decoding BSON document data to native PHP
@@ -17,12 +19,14 @@ interface DocumentCodec extends Codec
      * @param mixed $value
      * @psalm-param Document $value
      * @psalm-return ObjectType
+     * @throws UndecodableValueException if the decoder does not support the value
      */
     public function decode($value): object;
 
     /**
      * @param mixed $value
      * @psalm-param ObjectType $value
+     * @throws UnencodableValueException if the encoder does not support the value
      */
     public function encode($value): Document;
 }

src/Codec/EncodeIfSupported.php

@@ -2,6 +2,8 @@
 
 namespace MongoDB\Codec;
 
+use MongoDB\Exception\UnencodableValueException;
+
 /**
  * @psalm-template BSONType
  * @psalm-template NativeType
@@ -19,6 +21,7 @@ abstract public function canEncode($value): bool;
      * @psalm-param NativeType $value
      * @return mixed
      * @psalm-return BSONType
+     * @throws UnencodableValueException if the encoder does not support the value
      */
     abstract public function encode($value);
 

src/Codec/Encoder.php

@@ -2,7 +2,7 @@
 
 namespace MongoDB\Codec;
 
-use MongoDB\Exception\InvalidArgumentException;
+use MongoDB\Exception\UnencodableValueException;
 
 /**
  * @psalm-template BSONType
@@ -26,7 +26,7 @@ public function canEncode($value): bool;
      * @psalm-param NativeType $value
      * @return mixed
      * @psalm-return BSONType
-     * @throws InvalidArgumentException if the decoder does not support the value
+     * @throws UnencodableValueException if the encoder does not support the value
      */
     public function encode($value);
 

src/Exception/UndecodableValueException.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace MongoDB\Exception;
+
+use InvalidArgumentException;
+
+use function get_debug_type;
+use function sprintf;
+
+class UndecodableValueException extends InvalidArgumentException implements Exception
+{
+    /** @var mixed */
+    private $value;
+
+    /** @param mixed $value */
+    public function __construct($value)
+    {
+        parent::__construct(sprintf('Could not decode value of type "%s".', get_debug_type($value)));
+
+        $this->value = $value;
+    }
+
+    /** @return mixed */
+    public function getValue()
+    {
+        return $this->value;
+    }
+}

src/Exception/UnencodableValueException.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace MongoDB\Exception;
+
+use InvalidArgumentException;
+
+use function get_debug_type;
+use function sprintf;
+
+class UnencodableValueException extends InvalidArgumentException implements Exception
+{
+    /** @var mixed */
+    private $value;
+
+    /** @param mixed $value */
+    public function __construct($value)
+    {
+        parent::__construct(sprintf('Could not encode value of type "%s".', get_debug_type($value)));
+
+        $this->value = $value;
+    }
+
+    /** @return mixed */
+    public function getValue()
+    {
+        return $this->value;
+    }
+}