Contract: Add and adopt MethodNotImplementedException and others

Author: lkrms

src/Toolkit/Contract/Core/MethodNotImplementedExceptionInterface.php

@@ -0,0 +1,31 @@
+<?php declare(strict_types=1);
+
+namespace Salient\Contract\Core;
+
+use Throwable;
+
+/**
+ * @api
+ */
+interface MethodNotImplementedExceptionInterface extends Throwable
+{
+    /**
+     * Get the name of the class that has not implemented the method
+     *
+     * @return class-string
+     */
+    public function getClass(): string;
+
+    /**
+     * Get the name of the method that has not been implemented
+     */
+    public function getMethod(): string;
+
+    /**
+     * Get the name of the class or interface from which the unimplemented
+     * method is inherited
+     *
+     * @return class-string
+     */
+    public function getPrototypeClass(): string;
+}

src/Toolkit/Contract/Core/ProviderInterface.php

@@ -4,7 +4,6 @@
 
 use Salient\Contract\Container\ContainerInterface;
 use Salient\Contract\Container\HasContainer;
-use Salient\Core\Exception\MethodNotImplementedException;
 use Stringable;
 
 /**
@@ -77,8 +76,8 @@ public function getContext(?ContainerInterface $container = null): ProviderConte
      * must never be cached.
      *
      * @return $this
-     * @throws MethodNotImplementedException if heartbeat monitoring isn't
-     * supported.
+     * @throws MethodNotImplementedExceptionInterface if heartbeat monitoring
+     * isn't supported.
      */
     public function checkHeartbeat(int $ttl = 300);
 }

src/Toolkit/Contract/Sync/Exception/FilterPolicyViolationExceptionInterface.php

@@ -0,0 +1,6 @@
+<?php declare(strict_types=1);
+
+namespace Salient\Contract\Sync\Exception;
+
+/** @api */
+interface FilterPolicyViolationExceptionInterface extends SyncExceptionInterface {}

src/Toolkit/Contract/Sync/Exception/InvalidFilterExceptionInterface.php

@@ -0,0 +1,6 @@
+<?php declare(strict_types=1);
+
+namespace Salient\Contract\Sync\Exception;
+
+/** @api */
+interface InvalidFilterExceptionInterface extends SyncExceptionInterface {}

src/Toolkit/Contract/Sync/Exception/InvalidFilterSignatureExceptionInterface.php

@@ -0,0 +1,6 @@
+<?php declare(strict_types=1);
+
+namespace Salient\Contract\Sync\Exception;
+
+/** @api */
+interface InvalidFilterSignatureExceptionInterface extends InvalidFilterExceptionInterface {}

src/Toolkit/Contract/Sync/Exception/SyncEntityNotFoundExceptionInterface.php

@@ -0,0 +1,6 @@
+<?php declare(strict_types=1);
+
+namespace Salient\Contract\Sync\Exception;
+
+/** @api */
+interface SyncEntityNotFoundExceptionInterface extends SyncExceptionInterface {}

src/Toolkit/Contract/Sync/Exception/SyncEntityRecursionExceptionInterface.php

@@ -0,0 +1,6 @@
+<?php declare(strict_types=1);
+
+namespace Salient\Contract\Sync\Exception;
+
+/** @api */
+interface SyncEntityRecursionExceptionInterface extends SyncExceptionInterface {}

src/Toolkit/Contract/Sync/Exception/SyncExceptionInterface.php

@@ -0,0 +1,8 @@
+<?php declare(strict_types=1);
+
+namespace Salient\Contract\Sync\Exception;
+
+use Throwable;
+
+/** @api */
+interface SyncExceptionInterface extends Throwable {}

src/Toolkit/Contract/Sync/FilterPolicy.php

@@ -2,7 +2,7 @@
 
 namespace Salient\Contract\Sync;
 
-use Salient\Sync\Exception\SyncFilterPolicyViolationException;
+use Salient\Contract\Sync\Exception\FilterPolicyViolationExceptionInterface;
 
 /**
  * Policies for unclaimed sync operation filters
@@ -20,8 +20,8 @@ interface FilterPolicy
     /**
      * Throw an exception if there are unclaimed filters
      *
-     * A {@see SyncFilterPolicyViolationException} is thrown and the request is
-     * not passed to the provider.
+     * A {@see FilterPolicyViolationExceptionInterface} is thrown and the
+     * request is not passed to the provider.
      *
      * This is the default policy.
      */

src/Toolkit/Contract/Sync/SyncContextInterface.php

@@ -3,9 +3,9 @@
 namespace Salient\Contract\Sync;
 
 use Salient\Contract\Core\ProviderContextInterface;
-use Salient\Sync\Exception\SyncEntityRecursionException;
-use Salient\Sync\Exception\SyncInvalidFilterException;
-use Salient\Sync\Exception\SyncInvalidFilterSignatureException;
+use Salient\Contract\Sync\Exception\InvalidFilterExceptionInterface;
+use Salient\Contract\Sync\Exception\InvalidFilterSignatureExceptionInterface;
+use Salient\Contract\Sync\Exception\SyncEntityRecursionExceptionInterface;
 use DateTimeInterface;
 
 /**
@@ -63,7 +63,7 @@ interface SyncContextInterface extends ProviderContextInterface
      * @param mixed ...$args Sync operation arguments, not including the
      * {@see SyncContextInterface} argument.
      * @return static
-     * @throws SyncInvalidFilterSignatureException
+     * @throws InvalidFilterSignatureExceptionInterface
      */
     public function withFilter($operation, ...$args);
 
@@ -143,7 +143,7 @@ public function pushWithRecursionCheck(SyncEntityInterface $entity);
     /**
      * Throw an exception if recursion is detected
      *
-     * @throws SyncEntityRecursionException if
+     * @throws SyncEntityRecursionExceptionInterface if
      * {@see SyncContextInterface::pushWithRecursionCheck()} detected recursion.
      */
     public function maybeThrowRecursionException(): void;
@@ -211,7 +211,7 @@ public function getFilter(?string $key = null, bool $orValue = true);
      * Same as {@see SyncContextInterface::getFilter()}, but an exception is
      * thrown if the value is not an integer.
      *
-     * @throws SyncInvalidFilterException
+     * @throws InvalidFilterExceptionInterface
      */
     public function getFilterInt(string $key, bool $orValue = true): ?int;
 
@@ -222,7 +222,7 @@ public function getFilterInt(string $key, bool $orValue = true): ?int;
      * Same as {@see SyncContextInterface::getFilter()}, but an exception is
      * thrown if the value is not a string.
      *
-     * @throws SyncInvalidFilterException
+     * @throws InvalidFilterExceptionInterface
      */
     public function getFilterString(string $key, bool $orValue = true): ?string;
 
@@ -234,7 +234,7 @@ public function getFilterString(string $key, bool $orValue = true): ?string;
      * thrown if the value is not an integer or string.
      *
      * @return int|string|null
-     * @throws SyncInvalidFilterException
+     * @throws InvalidFilterExceptionInterface
      */
     public function getFilterArrayKey(string $key, bool $orValue = true);
 
@@ -246,7 +246,7 @@ public function getFilterArrayKey(string $key, bool $orValue = true);
      * thrown if the value is not a list of integers.
      *
      * @return int[]|null
-     * @throws SyncInvalidFilterException
+     * @throws InvalidFilterExceptionInterface
      */
     public function getFilterIntList(string $key, bool $orValue = true): ?array;
 
@@ -258,7 +258,7 @@ public function getFilterIntList(string $key, bool $orValue = true): ?array;
      * thrown if the value is not a list of strings.
      *
      * @return string[]|null
-     * @throws SyncInvalidFilterException
+     * @throws InvalidFilterExceptionInterface
      */
     public function getFilterStringList(string $key, bool $orValue = true): ?array;
 
@@ -270,7 +270,7 @@ public function getFilterStringList(string $key, bool $orValue = true): ?array;
      * thrown if the value is not a list of integers and strings.
      *
      * @return (int|string)[]|null
-     * @throws SyncInvalidFilterException
+     * @throws InvalidFilterExceptionInterface
      */
     public function getFilterArrayKeyList(string $key, bool $orValue = true): ?array;
 
@@ -303,7 +303,7 @@ public function claimFilter(string $key, bool $orValue = true);
      * Same as {@see SyncContextInterface::claimFilter()}, but an exception is
      * thrown if the value is not an integer.
      *
-     * @throws SyncInvalidFilterException
+     * @throws InvalidFilterExceptionInterface
      */
     public function claimFilterInt(string $key, bool $orValue = true): ?int;
 
@@ -314,7 +314,7 @@ public function claimFilterInt(string $key, bool $orValue = true): ?int;
      * Same as {@see SyncContextInterface::claimFilter()}, but an exception is
      * thrown if the value is not a string.
      *
-     * @throws SyncInvalidFilterException
+     * @throws InvalidFilterExceptionInterface
      */
     public function claimFilterString(string $key, bool $orValue = true): ?string;
 
@@ -326,7 +326,7 @@ public function claimFilterString(string $key, bool $orValue = true): ?string;
      * thrown if the value is not an integer or string.
      *
      * @return int|string|null
-     * @throws SyncInvalidFilterException
+     * @throws InvalidFilterExceptionInterface
      */
     public function claimFilterArrayKey(string $key, bool $orValue = true);
 
@@ -338,7 +338,7 @@ public function claimFilterArrayKey(string $key, bool $orValue = true);
      * thrown if the value is not a list of integers.
      *
      * @return int[]|null
-     * @throws SyncInvalidFilterException
+     * @throws InvalidFilterExceptionInterface
      */
     public function claimFilterIntList(string $key, bool $orValue = true): ?array;
 
@@ -350,7 +350,7 @@ public function claimFilterIntList(string $key, bool $orValue = true): ?array;
      * thrown if the value is not a list of strings.
      *
      * @return string[]|null
-     * @throws SyncInvalidFilterException
+     * @throws InvalidFilterExceptionInterface
      */
     public function claimFilterStringList(string $key, bool $orValue = true): ?array;
 
@@ -362,7 +362,7 @@ public function claimFilterStringList(string $key, bool $orValue = true): ?array
      * thrown if the value is not a list of integers and strings.
      *
      * @return (int|string)[]|null
-     * @throws SyncInvalidFilterException
+     * @throws InvalidFilterExceptionInterface
      */
     public function claimFilterArrayKeyList(string $key, bool $orValue = true): ?array;