PHPdoc added

Author: Smoren

src/Exceptions/IndexError.php

@@ -4,6 +4,9 @@
 
 namespace Smoren\ArrayView\Exceptions;
 
+/**
+ * Error class for index-related errors.
+ */
 class IndexError extends \RuntimeException
 {
 }

src/Exceptions/KeyError.php

@@ -4,6 +4,9 @@
 
 namespace Smoren\ArrayView\Exceptions;
 
+/**
+ * Error class for key-related errors.
+ */
 class KeyError extends \RuntimeException
 {
 }

src/Exceptions/NotSupportedError.php

@@ -4,6 +4,9 @@
 
 namespace Smoren\ArrayView\Exceptions;
 
+/**
+ * Error class for not supported errors.
+ */
 class NotSupportedError extends \Exception
 {
 }

src/Exceptions/ReadonlyError.php

@@ -4,6 +4,9 @@
 
 namespace Smoren\ArrayView\Exceptions;
 
+/**
+ * Error class for readonly-related errors.
+ */
 class ReadonlyError extends \RuntimeException
 {
 }

src/Exceptions/SizeError.php

@@ -4,6 +4,9 @@
 
 namespace Smoren\ArrayView\Exceptions;
 
+/**
+ * Error class for size-related errors.
+ */
 class SizeError extends \RuntimeException
 {
 }

src/Exceptions/ValueError.php

@@ -4,6 +4,9 @@
 
 namespace Smoren\ArrayView\Exceptions;
 
+/**
+ * Error class for value-related errors.
+ */
 class ValueError extends \RuntimeException
 {
 }

src/Interfaces/ArraySelectorInterface.php

@@ -4,19 +4,26 @@
 
 namespace Smoren\ArrayView\Interfaces;
 
+/**
+ * Interface for selecting elements from an array view.
+ */
 interface ArraySelectorInterface
 {
  /**
- * @template T
+ * Selects elements from a source array view based on the selector criteria.
  *
- * @param ArrayViewInterface<T> $source
- * @param bool|null $readonly
+ * @template T The type of elements in the source array view.
  *
- * @return ArrayViewInterface<T>
+ * @param ArrayViewInterface<T> $source The source array view to select elements from.
+ * @param bool|null $readonly Flag indicating if the result view should be read-only.
+ *
+ * @return ArrayViewInterface<T> A new view with selected elements from the source.
  */
  public function select(ArrayViewInterface $source, ?bool $readonly = null): ArrayViewInterface;
 
  /**
+ * Return value of the selector.
+ *
  * @return mixed
  */
  public function getValue();

src/Interfaces/ArrayViewInterface.php

@@ -4,6 +4,13 @@
 
 namespace Smoren\ArrayView\Interfaces;
 
+use Smoren\ArrayView\Exceptions\IndexError;
+use Smoren\ArrayView\Exceptions\KeyError;
+use Smoren\ArrayView\Exceptions\NotSupportedError;
+use Smoren\ArrayView\Exceptions\ReadonlyError;
+use Smoren\ArrayView\Exceptions\SizeError;
+use Smoren\ArrayView\Exceptions\ValueError;
+
 /**
  * Interface for a view of an array with additional methods
  * for filtering, mapping, and transforming the data.
@@ -27,6 +34,9 @@ interface ArrayViewInterface extends \ArrayAccess, \IteratorAggregate, \Countabl
  * @param bool|null $readonly Optional flag to indicate whether the view should be readonly.
  *
  * @return ArrayViewInterface<T> An ArrayView instance based on the source array or ArrayView.
+ *
+ * @throws ValueError if the array is not sequential.
+ * @throws ReadonlyError if the source is readonly and trying to create a non-readonly view.
  */
  public static function toView(&$source, ?bool $readonly = null): ArrayViewInterface;
 
@@ -42,6 +52,9 @@ public static function toView(&$source, ?bool $readonly = null): ArrayViewInterf
  * @param bool|null $readonly Optional flag to indicate whether the view should be readonly.
  *
  * @return ArrayViewInterface<T> An ArrayView instance based on the source array or ArrayView.
+ *
+ * @throws ValueError if the array is not sequential.
+ * @throws ReadonlyError if the source is readonly and trying to create a non-readonly view.
  */
  public static function toUnlinkedView($source, ?bool $readonly = null): ArrayViewInterface;
 
@@ -98,6 +111,9 @@ public function apply(callable $mapper): self;
  * @param callable(T, U, int): T $mapper Function to transform each pair of elements.
  *
  * @return ArrayViewInterface<T> this view.
+ *
+ * @throws ValueError if the $data is not sequential array.
+ * @throws SizeError if size of $data not equals to size of the view.
  */
  public function applyWith($data, callable $mapper): self;
 
@@ -107,6 +123,9 @@ public function applyWith($data, callable $mapper): self;
  * @param array<T>|ArrayViewInterface<T>|T $newValues The new values to set.
  *
  * @return ArrayViewInterface<T> this view.
+ *
+ * @throws ValueError if the $newValues is not sequential array.
+ * @throws SizeError if size of $newValues not equals to size of the view.
  */
  public function set($newValues): self;
 
@@ -138,6 +157,9 @@ public function offsetExists($offset): bool;
  *
  * @return T|array<T>
  *
+ * @throws IndexError if the offset is out of range.
+ * @throws KeyError if the key is invalid.
+ *
  * {@inheritDoc}
  */
  #[\ReturnTypeWillChange]
@@ -149,6 +171,10 @@ public function offsetGet($offset);
  *
  * @return void
  *
+ * @throws IndexError if the offset is out of range.
+ * @throws KeyError if the key is invalid.
+ * @throws ReadonlyError if the object is readonly.
+ *
  * {@inheritDoc}
  */
  public function offsetSet($offset, $value): void;
@@ -158,6 +184,8 @@ public function offsetSet($offset, $value): void;
  *
  * @return void
  *
+ * @throws NotSupportedError always.
+ *
  * {@inheritDoc}
  */
  public function offsetUnset($offset): void;

src/Interfaces/IndexListSelectorInterface.php

@@ -4,9 +4,14 @@
 
 namespace Smoren\ArrayView\Interfaces;
 
+/**
+ * Interface for selecting elements from an array view by boolean mask.
+ */
 interface IndexListSelectorInterface extends ArraySelectorInterface
 {
  /**
+ * Return index list array.
+ *
  * @return array<int>
  */
  public function getValue(): array;

src/Interfaces/MaskSelectorInterface.php

@@ -4,9 +4,14 @@
 
 namespace Smoren\ArrayView\Interfaces;
 
+/**
+ * Interface for selecting elements from an array view by boolean mask.
+ */
 interface MaskSelectorInterface extends ArraySelectorInterface
 {
  /**
+ * Return boolean mask array.
+ *
  * @return array<bool>
  */
  public function getValue(): array;