PHPdoc, strict types added.

Author: Smoren

src/Exceptions/IndexError.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Smoren\ArrayView\Exceptions;
 
 class IndexError extends \RuntimeException

src/Exceptions/KeyError.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Smoren\ArrayView\Exceptions;
 
 class KeyError extends \RuntimeException

src/Exceptions/NotSupportedError.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Smoren\ArrayView\Exceptions;
 
 class NotSupportedError extends \Exception

src/Exceptions/ReadonlyError.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Smoren\ArrayView\Exceptions;
 
 class ReadonlyError extends \RuntimeException

src/Exceptions/SizeError.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Smoren\ArrayView\Exceptions;
 
 class SizeError extends \RuntimeException

src/Exceptions/ValueError.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Smoren\ArrayView\Exceptions;
 
 class ValueError extends \RuntimeException

src/Interfaces/ArrayViewInterface.php

@@ -5,80 +5,121 @@
 namespace Smoren\ArrayView\Interfaces;
 
 /**
- * @template T
+ * Interface for a view of an array with additional methods
+ * for filtering, mapping, and transforming the data.
+ *
+ * @template T The type of elements in the array
+ *
  * @extends \ArrayAccess<int, T|array<T>>
  * @extends \IteratorAggregate<int, T>
  */
 interface ArrayViewInterface extends \ArrayAccess, \IteratorAggregate, \Countable
 {
  /**
- * @param array<T>|ArrayViewInterface<T> $source
- * @param bool|null $readonly
- * @return ArrayViewInterface<T>
+ * Creates an ArrayView instance from the given source array or ArrayView.
+ *
+ * * If the source is not an ArrayView, a new ArrayView is created with the provided source.
+ * * If the source is an ArrayView and the `readonly` parameter is specified as `true`,
+ * a new readonly ArrayView is created.
+ * * If the source is an ArrayView and it is already readonly, the same ArrayView is returned.
+ *
+ * @param array<T>|ArrayViewInterface<T> $source The source array or ArrayView to create a view from.
+ * @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.
  */
  public static function toView(&$source, ?bool $readonly = null): ArrayViewInterface;
 
  /**
- * @param array<T>|ArrayViewInterface<T> $source
- * @param bool|null $readonly
- * @return ArrayViewInterface<T>
+ * Creates an unlinked from source ArrayView instance from the given source array or ArrayView.
+ *
+ * * If the source is not an ArrayView, a new ArrayView is created with the provided source.
+ * * If the source is an ArrayView and the `readonly` parameter is specified as `true`,
+ * a new readonly ArrayView is created.
+ * * If the source is an ArrayView and it is already readonly, the same ArrayView is returned.
+ *
+ * @param array<T>|ArrayViewInterface<T> $source The source array or ArrayView to create a view from.
+ * @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.
  */
  public static function toUnlinkedView($source, ?bool $readonly = null): ArrayViewInterface;
 
  /**
- * @return array<T>
+ * Returns the array representation of the view.
+ *
+ * @return array<T> The array representation of the view.
  */
  public function toArray(): array;
 
  /**
- * @param callable(T): bool $predicate
- * @return ArrayViewInterface<T>
+ * Filters the elements in the view based on a predicate function.
+ *
+ * @param callable(T): bool $predicate Function that returns a boolean value for each element.
+ *
+ * @return ArrayViewInterface<T> A new view with elements that satisfy the predicate.
  */
  public function filter(callable $predicate): ArrayViewInterface;
 
  /**
- * @param callable(T): bool $predicate
- * @return MaskSelectorInterface
+ * Checks if all elements in the view satisfy a given predicate function.
+ *
+ * @param callable(T): bool $predicate Function that returns a boolean value for each element.
+ *
+ * @return MaskSelectorInterface Boolean mask for selecting elements that satisfy the predicate.
  */
  public function is(callable $predicate): MaskSelectorInterface;
 
  /**
- * @param ArraySelectorInterface|string $selector
- * @param bool|null $readonly
- * @return ArrayViewInterface<T>
+ * Returns a subview of this view based on a selector or string slice.
+ *
+ * @param ArraySelectorInterface|string $selector The selector or string to filter the subview.
+ * @param bool|null $readonly Flag indicating if the subview should be read-only.
+ *
+ * @return ArrayViewInterface<T> A new view representing the subview of this view.
  */
  public function subview($selector, bool $readonly = null): ArrayViewInterface;
 
  /**
- * @param callable(T, int): T $mapper
+ * Applies a transformation function to each element in the view.
+ *
+ * @param callable(T, int): T $mapper Function to transform each element.
  *
- * @return ArrayViewInterface<T>
+ * @return ArrayViewInterface<T> this view.
  */
  public function apply(callable $mapper): self;
 
  /**
- * @template U
+ * Applies a transformation function using another array or view as rhs values for a binary operation.
+ *
+ * @template U The type rhs of a binary operation.
  *
- * @param array<U>|ArrayViewInterface<U> $data
- * @param callable(T, U, int): T $mapper
+ * @param array<U>|ArrayViewInterface<U> $data The rhs values for a binary operation.
+ * @param callable(T, U, int): T $mapper Function to transform each pair of elements.
  *
- * @return ArrayViewInterface<T>
+ * @return ArrayViewInterface<T> this view.
  */
  public function applyWith($data, callable $mapper): self;
 
  /**
- * @param array<T>|ArrayViewInterface<T>|T $newValues
+ * Sets new values for the elements in the view.
  *
- * @return ArrayViewInterface<T>
+ * @param array<T>|ArrayViewInterface<T>|T $newValues The new values to set.
+ *
+ * @return ArrayViewInterface<T> this view.
  */
  public function set($newValues): self;
 
  /**
+ * Return true if view is readonly, otherwise false.
+ *
  * @return bool
  */
  public function isReadonly(): bool;
 
  /**
+ * Return size of the view.
+ *
  * @return int
  */
  public function count(): int;
@@ -87,13 +128,17 @@ public function count(): int;
  * @param numeric|string|ArraySelectorInterface $offset
  *
  * @return bool
+ *
+ * {@inheritDoc}
  */
  public function offsetExists($offset): bool;
 
  /**
  * @param numeric|string|ArraySelectorInterface $offset
  *
  * @return T|array<T>
+ *
+ * {@inheritDoc}
  */
  #[\ReturnTypeWillChange]
  public function offsetGet($offset);
@@ -103,17 +148,23 @@ public function offsetGet($offset);
  * @param T|array<T>|ArrayViewInterface<T> $value
  *
  * @return void
+ *
+ * {@inheritDoc}
  */
  public function offsetSet($offset, $value): void;
 
  /**
  * @param numeric|string|ArraySelectorInterface $offset
  *
  * @return void
+ *
+ * {@inheritDoc}
  */
  public function offsetUnset($offset): void;
 
  /**
+ * Return iterator to iterate the view elements.
+ *
  * @return \Generator<int, T>
  */
  public function getIterator(): \Generator;

src/Selectors/IndexListSelector.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Smoren\ArrayView\Selectors;
 
 use Smoren\ArrayView\Interfaces\ArrayViewInterface;

src/Selectors/MaskSelector.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Smoren\ArrayView\Selectors;
 
 use Smoren\ArrayView\Interfaces\ArrayViewInterface;

src/Selectors/SliceSelector.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 namespace Smoren\ArrayView\Selectors;
 
 use Smoren\ArrayView\Interfaces\ArraySelectorInterface;