Adding package specific ForbiddenOperation exception

Author: nyamsprod

CHANGELOG.md

@@ -9,15 +9,15 @@ All Notable changes to `bakame/http-strucured-fields` will be documented in this
 - Support for `Stringable` instances added to `Item::from`, the instances will be converted to the string data type.
 - Support for the upcoming `Date` data type in `Item`. (see https://httpwg.org/http-extensions/draft-ietf-httpbis-sfbis.html)
   - date type is represented as a `DateTimeImmutable` object.
-  - `Item::isDate` tells whether the instance represents a `Date` DataType.
-- `ParameterAccess` interface updated with 4 new methods to ease parameter members modification.
+- `ParameterAccess` interface updated with new methods to ease parameter members modification.
 - `Parameter::create` named constructor to create a new instance without any parameter.
 - `Dictionnary::create` named constructor to create a new instance without any parameter.
 - `Type` Enum to list all possible Item Type supported.
 - `Value` Interface is introduced with `Item` being the only available implementation.
 - `MemberOrderedMap::add` and `MemberOrderedMap::remove` methods
 - `ByteSequence::equals` and `Token::equals` to easily compare type instances.
 - `StructuredField` extends the `Stringable` interface
+- `ForbiddenOperation` exception to reports invalid operation on immutable value objects.
 
 ### Fixed
 
@@ -26,7 +26,7 @@ All Notable changes to `bakame/http-strucured-fields` will be documented in this
 - **[BC Break]** `::fromAssociative`, `::fromList`, `::fromPairs` methods require iterable arguments without default value.
 - **[BC Break]** `Item::value` method returns the Item (returns value can be `float|int|string|bool|ByteSequence|DateTimeImmutable|Token`).
 - **[BC Break]** `InnerList::parameters` is no longer accessible as a public readonly property.
-- **[BC Break]** Modifying container instances with `ArrayAccess` modifying methods is forbidden and will trigger a `LogicException` exception.
+- **[BC Break]** Modifying container instances with `ArrayAccess` modifying methods is forbidden and will trigger a `ForbiddenOperation` exception.
 
 ### Deprecated
 

src/Dictionary.php

@@ -7,7 +7,6 @@
 use ArrayAccess;
 use DateTimeInterface;
 use Iterator;
-use LogicException;
 use Stringable;
 use function array_key_exists;
 use function array_keys;
@@ -306,11 +305,11 @@ public function offsetGet(mixed $offset): InnerList|Value
 
     public function offsetUnset(mixed $offset): void
     {
-        throw new LogicException(self::class.' instance can not be updated using '.ArrayAccess::class.' methods.');
+        throw new ForbiddenOperation(self::class.' instance can not be updated using '.ArrayAccess::class.' methods.');
     }
 
     public function offsetSet(mixed $offset, mixed $value): void
     {
-        throw new LogicException(self::class.' instance can not be updated using '.ArrayAccess::class.' methods.');
+        throw new ForbiddenOperation(self::class.' instance can not be updated using '.ArrayAccess::class.' methods.');
     }
 }

src/ForbiddenOperation.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Bakame\Http\StructuredFields;
+
+use LogicException;
+
+final class ForbiddenOperation extends LogicException implements StructuredFieldError
+{
+}

src/InnerList.php

@@ -7,7 +7,6 @@
 use ArrayAccess;
 use DateTimeInterface;
 use Iterator;
-use LogicException;
 use Stringable;
 use function array_filter;
 use function array_map;
@@ -252,11 +251,11 @@ public function offsetGet(mixed $offset): Value
 
     public function offsetUnset(mixed $offset): void
     {
-        throw new LogicException(self::class.' instance can not be updated using '.ArrayAccess::class.' methods.');
+        throw new ForbiddenOperation(self::class.' instance can not be updated using '.ArrayAccess::class.' methods.');
     }
 
     public function offsetSet(mixed $offset, mixed $value): void
     {
-        throw new LogicException(self::class.' instance can not be updated using '.ArrayAccess::class.' methods.');
+        throw new ForbiddenOperation(self::class.' instance can not be updated using '.ArrayAccess::class.' methods.');
     }
 }

src/OrderedList.php

@@ -7,7 +7,6 @@
 use ArrayAccess;
 use DateTimeInterface;
 use Iterator;
-use LogicException;
 use Stringable;
 use function array_filter;
 use function array_map;
@@ -233,11 +232,11 @@ public function offsetGet(mixed $offset): InnerList|Value
 
     public function offsetUnset(mixed $offset): void
     {
-        throw new LogicException(self::class.' instance can not be updated using '.ArrayAccess::class.' methods.');
+        throw new ForbiddenOperation(self::class.' instance can not be updated using '.ArrayAccess::class.' methods.');
     }
 
     public function offsetSet(mixed $offset, mixed $value): void
     {
-        throw new LogicException(self::class.' instance can not be updated using '.ArrayAccess::class.' methods.');
+        throw new ForbiddenOperation(self::class.' instance can not be updated using '.ArrayAccess::class.' methods.');
     }
 }

src/Parameters.php

@@ -7,7 +7,6 @@
 use ArrayAccess;
 use DateTimeInterface;
 use Iterator;
-use LogicException;
 use Stringable;
 use function array_key_exists;
 use function array_keys;
@@ -329,11 +328,11 @@ public function offsetGet(mixed $offset): Value
 
     public function offsetUnset(mixed $offset): void
     {
-        throw new LogicException(self::class.' instance can not be updated using '.ArrayAccess::class.' methods.');
+        throw new ForbiddenOperation(self::class.' instance can not be updated using '.ArrayAccess::class.' methods.');
     }
 
     public function offsetSet(mixed $offset, mixed $value): void
     {
-        throw new LogicException(self::class.' instance can not be updated using '.ArrayAccess::class.' methods.');
+        throw new ForbiddenOperation(self::class.' instance can not be updated using '.ArrayAccess::class.' methods.');
     }
 }