doc fixed

s3b4stian · s3b4stian · commit 4dad68743aca · 2022-12-31T13:52:59.000Z
diff --git a/.gitignore b/.gitignore
@@ -2,6 +2,10 @@ composer.phar
 composer.lock
 clover.xml
 infection-log.txt
+.phpdoc/cache/
 vendor/
+.phan/
 .php-cs-fixer.cache
-.phpunit.result.cache
+.phpunit.result.cache
+phpunit.local.xml
+phpdoc.xml
diff --git a/src/Linna/TypedArrayObject/AbstractArray.php b/src/Linna/TypedArrayObject/AbstractArray.php
@@ -12,11 +12,16 @@
 namespace Linna\TypedArrayObject;
 
 use ArrayObject;
+use ArrayIterator;
 use Closure;
 use InvalidArgumentException;
 
 /**
- * Provide a way to create an array of string typed elements with php.
+ * Provide a way to create an array of typed elements with php.
+ * 
+ * @extends ArrayObject<int|string, mixed>
+ * 
+ * @link https://www.php.net/manual/en/class.arrayobject.php
  */
 class AbstractArray extends ArrayObject
 {
@@ -26,15 +31,14 @@ class AbstractArray extends ArrayObject
     /**
      * Class Contructor.
      *
-     * @param Closure       $func               function to check the array values
-     * @param array<mixed>  $input              array of values
-     * @param int           $flags              see array object on php site
-     * @param string        $iterator_class     see array object on php site
+     * @param Closure       $func           Function to check the array values.
+     * @param array<mixed>  $input          Array of values.
+     * @param int           $flags          Flags to control the behaviour of the ArrayObject object. See array object on php site.
+     * @param class-string  $iterator_class Specify the class that will be used for iteration of the ArrayObject object. The class must implement ArrayIterator.
      *
-     * @throws InvalidArgumentException If elements in the optional array parameter
-     *                                  aren't of the configured type.
+     * @throws InvalidArgumentException If elements in the optional array parameter aren't of the configured type.
      */
-    public function __construct(Closure $func, array $input = [], int $flags = 0, string $iterator_class = "ArrayIterator")
+    public function __construct(Closure $func, array $input = [], int $flags = 0, string $iterator_class = ArrayIterator::class)
     {
         //check for invalid values inside provided array
         //array_map returns an array of trues or false
@@ -73,7 +77,7 @@ public function offsetSet($index, $newval): void
     /**
      * Append a value at the end of the array.
      *
-     * @param string $value
+     * @param mixed $value
      * @return void
      *
      * @throws InvalidArgumentException  If value passed with $value are not of the string type
diff --git a/src/Linna/TypedArrayObject/ArrayOfArrays.php b/src/Linna/TypedArrayObject/ArrayOfArrays.php
@@ -11,30 +11,36 @@
 
 namespace Linna\TypedArrayObject;
 
+use ArrayIterator;
 use InvalidArgumentException;
 
 /**
  * Provide a way to create an array of array typed elements with php.
+ * 
+ * @link https://www.php.net/manual/en/functions.first_class_callable_syntax.php
  */
 class ArrayOfArrays extends AbstractArray
 {
     /**
-     * It overrides parent message
-     * @var string Exception message
+     * It overrides parent message.
+     *
+     * @var string Exception message.
      */
     protected string $exceptionMessage = 'Elements passed must be of the type <array>.';
 
     /**
      * Class Contructor.
      *
-     * @param array<array>  $input
-     * @param int           $flags
-     * @param string        $iterator_class
+     * @param array<int|string, array<mixed>> $input          Array of values, every value must be an <code>array</code>.
+     * @param int                             $flags          Flags to control the behaviour of the <code>ArrayObject</code> object, 
+     *                                                        see <code>ArrayObject</code> on php site.
+     * @param class-string                    $iterator_class Specify the class that will be used for iteration of the 
+     *                                                        <code>ArrayObject</code> object, the class must 
+     *                                                        implement <code>ArrayIterator</code>.
      *
-     * @throws InvalidArgumentException If elements in the optional array parameter
-     *                                  aren't of the configured type.
+     * @throws InvalidArgumentException If elements in the optional array parameter aren't of the configured type.
      */
-    public function __construct(array $input = [], int $flags = 0, string $iterator_class = "ArrayIterator")
+    public function __construct(array $input = [], int $flags = 0, string $iterator_class = ArrayIterator::class)
     {
         // first argument is the php8.1 method to pass function reference as closure.
         // check https://www.php.net/manual/en/functions.first_class_callable_syntax.php
diff --git a/src/Linna/TypedArrayObject/ArrayOfBooleans.php b/src/Linna/TypedArrayObject/ArrayOfBooleans.php
@@ -11,30 +11,35 @@
 
 namespace Linna\TypedArrayObject;
 
+use ArrayIterator;
 use InvalidArgumentException;
 
 /**
  * Provide a way to create an array of boolean typed elements with php.
+ * 
+ * @link https://www.php.net/manual/en/functions.first_class_callable_syntax.php
  */
 class ArrayOfBooleans extends AbstractArray
 {
     /**
-     * It overrides parent message
-     * @var string Exception message
+     * It overrides parent message.
+     *
+     * @var string Exception message.
      */
     protected string $exceptionMessage = 'Elements passed must be of the type <bool>.';
 
     /**
      * Class Contructor.
      *
-     * @param array<bool>   $input
-     * @param int           $flags
-     * @param string        $iterator_class
+     * @param array<bool>  $input          Array of values, every value must be a <code>bool</code>.
+     * @param int          $flags          Flags to control the behaviour of the <code>ArrayObject</code> object, 
+     *                                     see <code>ArrayObject</code> on php site.
+     * @param class-string $iterator_class Specify the class that will be used for iteration of the <code>ArrayObject</code> 
+     *                                     object, the class must implement <code>ArrayIterator</code>.
      *
-     * @throws InvalidArgumentException If elements in the optional array parameter
-     *                                  aren't of the configured type.
+     * @throws InvalidArgumentException If elements in the optional array parameter aren't of the configured type.
      */
-    public function __construct(array $input = [], int $flags = 0, string $iterator_class = "ArrayIterator")
+    public function __construct(array $input = [], int $flags = 0, string $iterator_class = ArrayIterator::class)
     {
         // first argument is the php8.1 method to pass function reference as closure.
         // check https://www.php.net/manual/en/functions.first_class_callable_syntax.php
diff --git a/src/Linna/TypedArrayObject/ArrayOfCallable.php b/src/Linna/TypedArrayObject/ArrayOfCallable.php
@@ -11,30 +11,35 @@
 
 namespace Linna\TypedArrayObject;
 
+use ArrayIterator;
 use InvalidArgumentException;
 
 /**
  * Provide a way to create an array of callable typed elements with php.
+ * 
+ * @link https://www.php.net/manual/en/functions.first_class_callable_syntax.php
  */
 class ArrayOfCallable extends AbstractArray
 {
     /**
-     * It overrides parent message
-     * @var string Exception message
+     * It overrides parent message.
+     *
+     * @var string Exception message.
      */
     protected string $exceptionMessage = 'Elements passed must be of the type <callable>.';
 
     /**
      * Class Contructor.
      *
-     * @param array  $input
-     * @param int    $flags
-     * @param string $iterator_class
+     * @param array<callable> $input          Array of values, every value must be a <code>callable</code>.
+     * @param int             $flags          Flags to control the behaviour of the <code>ArrayObject</code> object, 
+     *                                        see <code>ArrayObject</code> on php site.
+     * @param class-string    $iterator_class Specify the class that will be used for iteration of the <code>ArrayObject</code> 
+     *                                        object, the class must implement <code>ArrayIterator</code>.
      *
-     * @throws InvalidArgumentException If elements in the optional array parameter
-     *                                  aren't of the configured type.
+     * @throws InvalidArgumentException If elements in the optional array parameter aren't of the configured type.
      */
-    public function __construct(array $input = [], int $flags = 0, string $iterator_class = "ArrayIterator")
+    public function __construct(array $input = [], int $flags = 0, string $iterator_class = ArrayIterator::class)
     {
         // first argument is the php8.1 method to pass function reference as closure.
         // check https://www.php.net/manual/en/functions.first_class_callable_syntax.php
diff --git a/src/Linna/TypedArrayObject/ArrayOfClasses.php b/src/Linna/TypedArrayObject/ArrayOfClasses.php
@@ -11,36 +11,41 @@
 
 namespace Linna\TypedArrayObject;
 
+use ArrayIterator;
 use InvalidArgumentException;
 
 /**
  * Provide a way for create an array of typed elements with php.
+ * 
+ * @link https://www.php.net/manual/en/functions.first_class_callable_syntax.php
  */
 class ArrayOfClasses extends AbstractArray
 {
     /**
-     * @var string Current type for array
+     * @var string Current type for array.
      */
     protected string $class;
 
     /**
-     * It overrides parent message
-     * @var string Exception message
+     * It overrides parent message.
+     *
+     * @var string Exception message.
      */
     protected string $exceptionMessage;
 
 
     /**
      * Class Contructor.
      *
-     * @param array<object> $input
-     * @param int           $flags
-     * @param string        $iterator_class
+     * @param array<object> $input          Array of values, every value must be a <code>object</code>.
+     * @param int           $flags          Flags to control the behaviour of the <code>ArrayObject</code> object, 
+     *                                      see <code>ArrayObject</code> on php site.
+     * @param class-string  $iterator_class Specify the class that will be used for iteration of the <code>ArrayObject</code> 
+     *                                      object, the class must implement <code>ArrayIterator</code>.
      *
-     * @throws InvalidArgumentException If elements in the optional array parameter
-     *                                  aren't of the configured type.
+     * @throws InvalidArgumentException If elements in the optional array parameter aren't of the configured type.
      */
-    public function __construct(string $class, array $input = [], int $flags = 0, string $iterator_class = "ArrayIterator")
+    public function __construct(string $class, array $input = [], int $flags = 0, string $iterator_class = ArrayIterator::class)
     {
         $this->class = $class;
         $this->exceptionMessage = "Elements passed must be of the type <{$class}>.";
@@ -50,11 +55,11 @@ public function __construct(string $class, array $input = [], int $flags = 0, st
     }
 
     /**
-     * Check if argument is instance of specific class.
+     * Check if the passed value is instance of specific class.
      *
-     * @param mixed $value
+     * @param mixed $value The value will be checked.
      *
-     * @return bool
+     * @return bool True if the value passed is a valid class, false otherwise.
      */
     protected function is_class(mixed $value): bool
     {
diff --git a/src/Linna/TypedArrayObject/ArrayOfFloats.php b/src/Linna/TypedArrayObject/ArrayOfFloats.php
@@ -11,30 +11,35 @@
 
 namespace Linna\TypedArrayObject;
 
+use ArrayIterator;
 use InvalidArgumentException;
 
 /**
  * Provide a way to create an array of float typed elements with php.
+ * 
+ * @link https://www.php.net/manual/en/functions.first_class_callable_syntax.php
  */
 class ArrayOfFloats extends AbstractArray
 {
     /**
-     * It overrides parent message
-     * @var string Exception message
+     * It overrides parent message.
+     *
+     * @var string Exception message.
      */
     protected string $exceptionMessage = 'Elements passed must be of the type <float>.';
 
     /**
      * Class Contructor.
      *
-     * @param array<float>  $input
-     * @param int           $flags
-     * @param string        $iterator_class
+     * @param array<float> $input          Array of values, every value must be a <code>float</code>.
+     * @param int          $flags          Flags to control the behaviour of the <code>ArrayObject</code> object, 
+     *                                     see <code>ArrayObject</code> on php site.
+     * @param class-string $iterator_class Specify the class that will be used for iteration of the <code>ArrayObject</code> 
+     *                                     object, the class must implement <code>ArrayIterator</code>.
      *
-     * @throws InvalidArgumentException If elements in the optional array parameter
-     *                                  aren't of the configured type.
+     * @throws InvalidArgumentException If elements in the optional array parameter aren't of the configured type.
      */
-    public function __construct(array $input = [], int $flags = 0, string $iterator_class = "ArrayIterator")
+    public function __construct(array $input = [], int $flags = 0, string $iterator_class = ArrayIterator::class)
     {
         // first argument is the php8.1 method to pass function reference as closure.
         // check https://www.php.net/manual/en/functions.first_class_callable_syntax.php
diff --git a/src/Linna/TypedArrayObject/ArrayOfIntegers.php b/src/Linna/TypedArrayObject/ArrayOfIntegers.php
@@ -11,30 +11,35 @@
 
 namespace Linna\TypedArrayObject;
 
+use ArrayIterator;
 use InvalidArgumentException;
 
 /**
  * Provide a way to create an array of integer typed elements with php.
+ * 
+ * @link https://www.php.net/manual/en/functions.first_class_callable_syntax.php
  */
 class ArrayOfIntegers extends AbstractArray
 {
     /**
-     * It overrides parent message
-     * @var string Exception message
+     * It overrides parent message.
+     *
+     * @var string Exception message.
      */
     protected string $exceptionMessage = 'Elements passed must be of the type <int>.';
 
     /**
      * Class Contructor.
      *
-     * @param array<int>    $input
-     * @param int           $flags
-     * @param string        $iterator_class
+     * @param array<int>   $input          Array of values, every value must be a <code>int</code>.
+     * @param int          $flags          Flags to control the behaviour of the <code>ArrayObject</code> object, 
+     *                                     see <code>ArrayObject</code> on php site.
+     * @param class-string $iterator_class Specify the class that will be used for iteration of the <code>ArrayObject</code> 
+     *                                     object, the class must implement <code>ArrayIterator</code>.
      *
-     * @throws InvalidArgumentException If elements in the optional array parameter
-     *                                  aren't of the configured type.
+     * @throws InvalidArgumentException If elements in the optional array parameter aren't of the configured type.
      */
-    public function __construct(array $input = [], int $flags = 0, string $iterator_class = "ArrayIterator")
+    public function __construct(array $input = [], int $flags = 0, string $iterator_class = ArrayIterator::class)
     {
         // first argument is the php8.1 method to pass function reference as closure.
         // check https://www.php.net/manual/en/functions.first_class_callable_syntax.php
diff --git a/src/Linna/TypedArrayObject/ArrayOfObjects.php b/src/Linna/TypedArrayObject/ArrayOfObjects.php
@@ -11,30 +11,35 @@
 
 namespace Linna\TypedArrayObject;
 
+use ArrayIterator;
 use InvalidArgumentException;
 
 /**
  * Provide a way to create an array of object typed elements with php.
+ * 
+ * @link https://www.php.net/manual/en/functions.first_class_callable_syntax.php
  */
 class ArrayOfObjects extends AbstractArray
 {
     /**
-     * It overrides parent message
-     * @var string Exception message
+     * It overrides parent message.
+     *
+     * @var string Exception message.
      */
     protected string $exceptionMessage = 'Elements passed must be of the type <object>.';
 
     /**
      * Class Contructor.
      *
-     * @param array<object> $input
-     * @param int           $flags
-     * @param string        $iterator_class
+     * @param array<object> $input          Array of values, every value must be a <code>object</code>.
+     * @param int           $flags          Flags to control the behaviour of the <code>ArrayObject</code> object, 
+     *                                      see <code>ArrayObject</code> on php site.
+     * @param class-string  $iterator_class Specify the class that will be used for iteration of the <code>ArrayObject</code> 
+     *                                      object, the class must implement <code>ArrayIterator</code>.
      *
-     * @throws InvalidArgumentException If elements in the optional array parameter
-     *                                  aren't of the configured type.
+     * @throws InvalidArgumentException If elements in the optional array parameter aren't of the configured type.
      */
-    public function __construct(array $input = [], int $flags = 0, string $iterator_class = "ArrayIterator")
+    public function __construct(array $input = [], int $flags = 0, string $iterator_class = ArrayIterator::class)
     {
         // first argument is the php8.1 method to pass function reference as closure.
         // check https://www.php.net/manual/en/functions.first_class_callable_syntax.php
diff --git a/src/Linna/TypedArrayObject/ArrayOfStrings.php b/src/Linna/TypedArrayObject/ArrayOfStrings.php
