Merge pull request #106 from marc-mabe/array-value

implemented #96: support type `array` in enumerator values

Author: marc-mabe

src/Enum.php

@@ -18,7 +18,7 @@ abstract class Enum
     /**
      * The selected enumerator value
      *
-     * @var null|bool|int|float|string
+     * @var null|bool|int|float|string|array
      */
     private $value;
 
@@ -53,8 +53,8 @@ abstract class Enum
     /**
      * Constructor
      *
-     * @param null|bool|int|float|string $value   The value of the enumerator
-     * @param int|null                   $ordinal The ordinal number of the enumerator
+     * @param null|bool|int|float|string|array $value   The value of the enumerator
+     * @param int|null                         $ordinal The ordinal number of the enumerator
      */
     final private function __construct($value, $ordinal = null)
     {
@@ -103,7 +103,7 @@ final public function __wakeup()
     /**
      * Get the value of the enumerator
      *
-     * @return null|bool|int|float|string
+     * @return null|bool|int|float|string|array
      */
     final public function getValue()
     {
@@ -164,7 +164,7 @@ final public function is($enumerator)
     /**
      * Get an enumerator instance of the given enumerator value or instance
      *
-     * @param static|null|bool|int|float|string $enumerator
+     * @param static|null|bool|int|float|string|array $enumerator
      * @return static
      * @throws InvalidArgumentException On an unknwon or invalid value
      * @throws LogicException           On ambiguous constant values
@@ -325,7 +325,7 @@ final public static function getConstants()
     /**
      * Test if the given enumerator is part of this enumeration
      * 
-     * @param static|null|bool|int|float|string $value
+     * @param static|null|bool|int|float|string|array $value
      * @return bool
      */
     final public static function has($enumerator)

src/EnumMap.php

@@ -87,7 +87,7 @@ public function getValues()
 
     /**
      * Search for the given value
-     * @param mixed $value
+     * @param null|bool|int|float|string|array $value
      * @param bool $strict Use strict type comparison
      * @return Enum|null The found key or NULL
      */
@@ -104,8 +104,8 @@ public function search($value, $strict = false)
 
     /**
      * Test if the given enumerator exists
-     * @param Enum|null|boolean|int|float|string $enumerator
-     * @return boolean
+     * @param Enum|null|bool|int|float|string|array $enumerator
+     * @return bool
      * @see offsetExists
      */
     public function contains($enumerator)
@@ -122,8 +122,8 @@ public function contains($enumerator)
 
     /**
      * Test if the given enumerator key exists and is not NULL
-     * @param Enum|null|boolean|int|float|string $enumerator
-     * @return boolean
+     * @param Enum|null|bool|int|float|string|array $enumerator
+     * @return bool
      * @see contains
      */
     public function offsetExists($enumerator)
@@ -140,7 +140,7 @@ public function offsetExists($enumerator)
 
     /**
      * Get mapped data for the given enumerator
-     * @param Enum|null|boolean|int|float|string $enumerator
+     * @param Enum|null|bool|int|float|string|array $enumerator
      * @return mixed
      * @throws InvalidArgumentException On an invalid given enumerator
      */
@@ -160,8 +160,8 @@ public function offsetGet($enumerator)
 
     /**
      * Attach a new enumerator or overwrite an existing one
-     * @param Enum|null|boolean|int|float|string $enumerator
-     * @param mixed                              $value
+     * @param Enum|null|bool|int|float|string|array $enumerator
+     * @param mixed                                 $value
      * @return void
      * @throws InvalidArgumentException On an invalid given enumerator
      * @see attach()
@@ -179,7 +179,7 @@ public function offsetSet($enumerator, $value = null)
 
     /**
      * Detach an existing enumerator
-     * @param Enum|null|boolean|int|float|string $enumerator
+     * @param Enum|null|bool|int|float|string|array $enumerator
      * @return void
      * @throws InvalidArgumentException On an invalid given enumerator
      * @see detach()
@@ -256,7 +256,7 @@ public function next()
 
     /**
      * Test if the iterator is in a valid state
-     * @return boolean
+     * @return bool
      */
     public function valid()
     {

src/EnumSet.php

@@ -106,7 +106,7 @@ public function getEnumeration()
 
     /**
      * Attach a new enumerator or overwrite an existing one
-     * @param Enum|null|boolean|int|float|string $enumerator
+     * @param Enum|null|bool|int|float|string|array $enumerator
      * @return void
      * @throws InvalidArgumentException On an invalid given enumerator
      */
@@ -118,7 +118,7 @@ public function attach($enumerator)
 
     /**
      * Detach the given enumerator
-     * @param Enum|null|boolean|int|float|string $enumerator
+     * @param Enum|null|bool|int|float|string|array $enumerator
      * @return void
      * @throws InvalidArgumentException On an invalid given enumerator
      */
@@ -130,8 +130,8 @@ public function detach($enumerator)
 
     /**
      * Test if the given enumerator was attached
-     * @param Enum|null|boolean|int|float|string $enumerator
-     * @return boolean
+     * @param Enum|null|bool|int|float|string|array $enumerator
+     * @return bool
      */
     public function contains($enumerator)
     {
@@ -233,7 +233,7 @@ private function doRewindInt()
 
     /**
      * Test if the iterator is in a valid state
-     * @return boolean
+     * @return bool
      */
     public function valid()
     {
@@ -710,7 +710,7 @@ public function setBinaryBitsetBe($bitset)
      * Get a bit at the given ordinal number
      *
      * @param int $ordinal Ordinal number of bit to get
-     * @return boolean
+     * @return bool
      */
     public function getBit($ordinal)
     {
@@ -727,7 +727,7 @@ public function getBit($ordinal)
      * This is the binary bitset implementation.
      *
      * @param int $ordinal Ordinal number of bit to get
-     * @return boolean
+     * @return bool
      * @see getBit
      * @see doGetBitInt
      */
@@ -742,7 +742,7 @@ private function doGetBitBin($ordinal)
      * This is the integer bitset implementation.
      * 
      * @param int $ordinal Ordinal number of bit to get
-     * @return boolean
+     * @return bool
      * @see getBit
      * @see doGetBitBin
      */