PHPDoc: fixed possible enum values descriped as 'scalar' by 'null|boolean|int|float|string'

Author: marc-mabe

src/MabeEnum/Enum.php

@@ -18,7 +18,7 @@ abstract class Enum
     /**
      * The selected value
      *
-     * @var null|scalar
+     * @var null|boolean|int|float|string
      */
     private $value;
 
@@ -46,8 +46,8 @@ abstract class Enum
     /**
      * Constructor
      *
-     * @param scalar $value The value to select
-     * @param int|null $ordinal
+     * @param null|boolean|int|float|string $value   The value to select
+     * @param int|null                      $ordinal The ordinal number of the value
      */
     final private function __construct($value, $ordinal = null)
     {
@@ -78,7 +78,7 @@ final private function __clone()
     /**
      * Get the current selected value
      *
-     * @return mixed
+     * @return null|boolean|int|float|string
      */
     final public function getValue()
     {
@@ -123,7 +123,7 @@ final public function getOrdinal()
     /**
      * Get an enum of the given value
      *
-     * @param scalar $value
+     * @param null|boolean|int|float|string $value
      * @return Enum
      * @throws InvalidArgumentException On an unknwon or invalid value
      * @throws LogicException           On ambiguous constant values

src/MabeEnum/EnumMap.php

@@ -148,8 +148,8 @@ public function getFlags()
 
     /**
      * Attach a new enumeration or overwrite an existing one
-     * @param Enum|scalar $enum
-     * @param mixed       $data
+     * @param Enum|null|boolean|int|float|string $enum
+     * @param mixed                              $data
      * @return void
      * @throws InvalidArgumentException On an invalid given enum
      */
@@ -160,7 +160,7 @@ public function attach($enum, $data = null)
 
     /**
      * Test if the given enumeration exists
-     * @param Enum|scalar $enum
+     * @param Enum|null|boolean|int|float|string $enum
      * @return boolean
      */
     public function contains($enum)
@@ -175,7 +175,7 @@ public function contains($enum)
 
     /**
      * Detach an enumeration
-     * @param Enum|scalar $enum
+     * @param Enum|null|boolean|int|float|string $enum
      * @return void
      * @throws InvalidArgumentException On an invalid given enum
      */
@@ -198,7 +198,7 @@ public function getHash($enum)
 
     /**
      * Test if the given enumeration exists
-     * @param Enum|scalar $enum
+     * @param Enum|null|boolean|int|float|string $enum
      * @return boolean
      * @see contains()
      */
@@ -209,7 +209,7 @@ public function offsetExists($enum)
 
     /**
      * Get mapped data for this given enum
-     * @param Enum|scalar $enum
+     * @param Enum|null|boolean|int|float|string $enum
      * @return mixed
      * @throws InvalidArgumentException On an invalid given enum
      */
@@ -220,8 +220,8 @@ public function offsetGet($enum)
 
     /**
      * Attach a new enumeration or overwrite an existing one
-     * @param Enum|scalar $enum
-     * @param mixed       $data
+     * @param Enum|null|boolean|int|float|string $enum
+     * @param mixed                              $data
      * @return void
      * @throws InvalidArgumentException On an invalid given enum
      * @see attach()
@@ -233,7 +233,7 @@ public function offsetSet($enum, $data = null)
 
     /**
      * Detach an existing enumeration
-     * @param Enum|scalar $enum
+     * @param Enum|null|boolean|int|float|string $enum
      * @return void
      * @throws InvalidArgumentException On an invalid given enum
      * @see detach()
@@ -269,7 +269,7 @@ public function current()
     /**
      * Get the current item-key
      * The return value varied by the behaviour of the key flag
-     * @return scalar
+     * @return null|boolean|int|float|string
      */
     public function key()
     {
@@ -289,7 +289,7 @@ public function key()
 
     /**
      * Initialize an enumeration
-     * @param Enum|scalar $enum
+     * @param Enum|null|boolean|int|float|string $enum
      * @return Enum
      * @throws InvalidArgumentException On an invalid given enum
      */

src/MabeEnum/EnumSet.php

@@ -87,7 +87,7 @@ public function getFlags()
 
     /**
      * Attach a new enumeration or overwrite an existing one
-     * @param Enum|scalar $enum
+     * @param Enum|null|boolean|int|float|string $enum
      * @return void
      * @throws InvalidArgumentException On an invalid given enum
      */
@@ -107,7 +107,7 @@ public function attach($enum)
 
     /**
      * Test if the given enumeration exists
-     * @param Enum|scalar $enum
+     * @param Enum|null|boolean|int|float|string $enum
      * @return boolean
      */
     public function contains($enum)
@@ -118,7 +118,7 @@ public function contains($enum)
 
     /**
      * Detach all enumerations same as the given enum
-     * @param Enum|scalar $enum
+     * @param Enum|null|boolean|int|float|string $enum
      * @return void
      * @throws InvalidArgumentException On an invalid given enum
      */
@@ -183,7 +183,7 @@ public function count()
 
     /**
      * Initialize an enumeration
-     * @param Enum|scalar $enum
+     * @param Enum|null|boolean|int|float|string $enum
      * @return Enum
      * @throws InvalidArgumentException On an invalid given enum
      */