Add array access support to ArgumentBag

CHANGELOG.md

@@ -1,3 +1,9 @@
+3.2.3
+=====
+
+* (improvement) Add `ArrayAccess` support to `ArgumentBag`.
+
+
 3.2.2
 =====
 

src/Exception/Structure/ImmutableDataException.php

@@ -0,0 +1,12 @@
+<?php declare(strict_types=1);
+
+namespace Torr\Rad\Exception\Structure;
+
+use Torr\Rad\Exception\RadException;
+
+/**
+ * @final
+ */
+class ImmutableDataException extends \BadMethodCallException implements RadException
+{
+}

src/Structure/ArgumentBag.php

@@ -3,6 +3,7 @@
 namespace Torr\Rad\Structure;
 
 use Symfony\Component\HttpFoundation\ParameterBag;
+use Torr\Rad\Exception\Structure\ImmutableDataException;
 use Torr\Rad\Exception\Structure\InvalidArgumentTypeException;
 use Torr\Rad\Exception\Structure\MissingArgumentException;
 
@@ -11,7 +12,7 @@
  *
  * @implements \IteratorAggregate<string, array|bool|string|int|float|object>
  */
-final readonly class ArgumentBag implements \IteratorAggregate, \Countable
+final readonly class ArgumentBag implements \IteratorAggregate, \Countable, \ArrayAccess
 {
 	/**
 	 * @param array<string, array|bool|string|int|float|object> $arguments
@@ -296,19 +297,61 @@ public function has (string $key) : bool
 		return \array_key_exists($key, $this->arguments);
 	}
 
+	//region IteratorAggregate implementation
 	/**
 	 *
 	 */
 	public function getIterator () : \Traversable
 	{
 		return new \ArrayIterator($this->arguments);
 	}
+	//endregion
 
+
+	//region Countable implementation
 	/**
 	 *
 	 */
 	public function count () : int
 	{
 		return \count($this->arguments);
 	}
+	//endregion
+
+
+	//region ArrayAccess implementation
+	/**
+	 *
+	 */
+	public function offsetExists (mixed $offset) : bool
+	{
+		return isset($this->arguments[$offset]);
+	}
+
+	/**
+	 *
+	 */
+	public function offsetGet (mixed $offset) : mixed
+	{
+		return $this->arguments[$offset] ?? null;
+	}
+
+	/**
+	 *
+	 */
+	public function offsetSet (mixed $offset, mixed $value) : void
+	{
+		throw new ImmutableDataException("The argument bag is read-only");
+	}
+
+	/**
+	 *
+	 */
+	public function offsetUnset (mixed $offset) : void
+	{
+		throw new ImmutableDataException("The argument bag is read-only");
+	}
+	//endregion
+
+
 }

tests/Structure/ArgumentBagTest.php

@@ -6,6 +6,7 @@
 use Tests\Torr\Rad\Fixtures\ExampleBackedEnum;
 use Tests\Torr\Rad\Fixtures\ExampleEntity;
 use Tests\Torr\Rad\Fixtures\ExampleEnum;
+use Torr\Rad\Exception\Structure\ImmutableDataException;
 use Torr\Rad\Exception\Structure\InvalidArgumentTypeException;
 use Torr\Rad\Exception\Structure\MissingArgumentException;
 use Torr\Rad\Structure\ArgumentBag;
@@ -105,6 +106,40 @@ public function testInvalidGetters (callable $getter, string $key) : void
 		$getter($key);
 	}
 
+	/**
+	 *
+	 */
+	public function testArrayAccess () : void
+	{
+		$bag = self::createBag();
+
+		self::assertSame($bag["object"], $bag->get("object"));
+		self::assertSame($bag["enum"], ExampleEnum::Test);
+	}
+
+	/**
+	 *
+	 */
+	public function testInvalidArraySet () : void
+	{
+		$this->expectException(ImmutableDataException::class);
+		$bag = self::createBag();
+
+		$bag["nope"] = "nope";
+	}
+
+	/**
+	 *
+	 */
+	public function testInvalidArrayUnset () : void
+	{
+		$this->expectException(ImmutableDataException::class);
+		$bag = self::createBag();
+
+		unset($bag["nope"]);
+	}
+
+
 	/**
 	 *
 	 */