Merge pull request #59 from wmde/master

Improve type hints on Exception properties
swaggest · Oct 24, 2022 · 9aaac36 · 9aaac36
2 parents 807bf7d + 8eec4c5
commit 9aaac36
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 15 deletions.
diff --git a/src/MissingFieldException.php b/src/MissingFieldException.php
@@ -2,18 +2,19 @@
 
 namespace Swaggest\JsonDiff;
 
+use Swaggest\JsonDiff\JsonPatch\OpPath;
 use Throwable;
 
 class MissingFieldException extends Exception
 {
     /** @var string */
     private $missingField;
-    /** @var object */
+    /** @var OpPath|object */
     private $operation;
 
     /**
      * @param string $missingField
-     * @param object $operation
+     * @param OpPath|object $operation
      * @param int $code
      * @param Throwable|null $previous
      */
@@ -38,7 +39,7 @@ public function getMissingField()
     }
 
     /**
-     * @return object
+     * @return OpPath|object
      */
     public function getOperation()
     {

diff --git a/src/PatchTestOperationFailedException.php b/src/PatchTestOperationFailedException.php
@@ -3,18 +3,19 @@
 namespace Swaggest\JsonDiff;
 
 
+use Swaggest\JsonDiff\JsonPatch\Test;
 use Throwable;
 
 class PatchTestOperationFailedException extends Exception
 {
-    /** @var object */
+    /** @var Test */
     private $operation;
-    /** @var string */
+    /** @var mixed */
     private $actualValue;
 
     /**
-     * @param object $operation
-     * @param string $actualValue
+     * @param Test $operation
+     * @param mixed $actualValue
      * @param int $code
      * @param Throwable|null $previous
      */
@@ -32,15 +33,15 @@ public function __construct(
     }
 
     /**
-     * @return object
+     * @return Test
      */
     public function getOperation()
     {
         return $this->operation;
     }
 
     /**
-     * @return string
+     * @return mixed
      */
     public function getActualValue()
     {

diff --git a/src/PathException.php b/src/PathException.php
@@ -3,19 +3,20 @@
 namespace Swaggest\JsonDiff;
 
 
+use Swaggest\JsonDiff\JsonPatch\OpPath;
 use Throwable;
 
 class PathException extends Exception
 {
-    /** @var object */
+    /** @var OpPath */
     private $operation;
 
     /** @var string */
     private $field;
 
     /**
      * @param string $message
-     * @param object $operation
+     * @param OpPath $operation
      * @param string $field
      * @param int $code
      * @param Throwable|null $previous
@@ -34,7 +35,7 @@ public function __construct(
     }
 
     /**
-     * @return object
+     * @return OpPath
      */
     public function getOperation()
     {

diff --git a/src/UnknownOperationException.php b/src/UnknownOperationException.php
@@ -3,15 +3,16 @@
 namespace Swaggest\JsonDiff;
 
 
+use Swaggest\JsonDiff\JsonPatch\OpPath;
 use Throwable;
 
 class UnknownOperationException extends Exception
 {
-    /** @var object */
+    /** @var OpPath|object */
     private $operation;
 
     /**
-     * @param object $operation
+     * @param OpPath|object $operation
      * @param int $code
      * @param Throwable|null $previous
      */
@@ -27,7 +28,7 @@ public function __construct(
     }
 
     /**
-     * @return object
+     * @return OpPath|object
      */
     public function getOperation()
     {