Merge pull request #19 from marc-mabe/feature/getBy

Implemented Enum::getBy[Name|Ordinal]() - fixes #18

Author: Marc Bennewitz

src/MabeEnum/Enum.php

@@ -128,7 +128,7 @@ final public function getOrdinal()
      * @throws InvalidArgumentException On an unknwon or invalid value
      * @throws LogicException           On ambiguous constant values
      */
-    static public function get($value)
+    final static public function get($value)
     {
         $class = get_called_class();
         $id    = $class . '.' . $value;
@@ -141,6 +141,45 @@ static public function get($value)
         return $instance;
     }
 
+    /**
+     * Get an enum by the given name
+     *
+     * @param string $name The name to instantiate the enum by
+     * @return Enum
+     * @throws InvalidArgumentException On an invalid or unknown name
+     * @throws LogicException           On ambiguous constant values
+     */
+    final public static function getByName($name)
+    {
+        $classConst = 'static::' . $name;
+        if (!defined($classConst)) {
+            $class = get_called_class();
+            throw new InvalidArgumentException($class . '::' . $name . ' not defined');
+        }
+        return static::get(constant($classConst));
+    }
+
+    /**
+     * Get an enum by the given ordinal number
+     *
+     * @param int $ordinal The ordinal number to instantiate the enum by
+     * @return Enum
+     * @throws InvalidArgumentException On an invalid ordinal number
+     * @throws LogicException           On ambiguous constant values
+     */
+    final public static function getByOrdinal($ordinal)
+    {
+        $constants = static::getConstants();
+        $item      = array_slice($constants, $ordinal, 1, false);
+        if (!$item) {
+            throw new InvalidArgumentException(sprintf(
+                'Invalid ordinal number, must between 0 and %s',
+                count($constants) - 1
+            ));
+        }
+        return static::get(current($item));
+    }
+
     /**
      * Clears all instantiated enums
      *
@@ -149,7 +188,7 @@ static public function get($value)
      * @param null|string $class
      * @return void
      */
-    final static function clear()
+    final static public function clear()
     {
         $class  = get_called_class();
 
@@ -212,18 +251,14 @@ final static public function getConstants()
      * This will be called automatically on calling a method
      * with the same name of a defined constant.
      *
-     * @param string $const The name of the constant to instantiate the enum with
-     * @param array  $args  There should be no arguments
-     * @throws BadMethodCallException On an unknown constant name (method name)
-     * @throws LogicException         On ambiguous constant values
+     * @param string $method The name to instantiate the enum by (called as method)
+     * @param array  $args   There should be no arguments
+     * @return Enum
+     * @throws InvalidArgumentException On an invalid or unknown name
+     * @throws LogicException           On ambiguous constant values
      */
-    final public static function __callStatic($const, array $args)
+    final public static function __callStatic($method, array $args)
     {
-        $classConst = 'static::' . $const;
-        if (!defined($classConst)) {
-            $class = get_called_class();
-            throw new BadMethodCallException($class . '::' . $const . ' not defined');
-        }
-        return static::get(constant($classConst));
+        return static::getByName($method);
     }
 }

tests/MabeEnumTest/EnumTest.php

@@ -72,17 +72,37 @@ public function testCallingGetOrdinalTwoTimesWillResultTheSameValue()
         $this->assertSame(1, $enum->getOrdinal());
     }
 
-    public function testInstantiateUsingMagicMethod()
+    public function testInstantiateUsingOrdinalNumber()
     {
-        $enum = EnumInheritance::ONE();
+        $enum = EnumInheritance::getByOrdinal(2);
+        $this->assertSame(2, $enum->getOrdinal());
+        $this->assertSame('INHERITANCE', $enum->getName());
+    }
+
+    public function testInstantiateUsingInvalidOrdinalNumberThrowsInvalidArgumentException()
+    {
+        $this->setExpectedException('InvalidArgumentException');
+        EnumInheritance::getByOrdinal(3);
+    }
+
+    public function testInstantiateByName()
+    {
+        $enum = EnumInheritance::getByName('ONE');
         $this->assertInstanceOf('MabeEnumTest\TestAsset\EnumInheritance', $enum);
         $this->assertSame(EnumInheritance::ONE, $enum->getValue());
     }
 
-    public function testInstantiateUsingMagicMethodThrowsBadMethodCallException()
+    public function testInstantiateByUnknownNameThrowsInvalidArgumentException()
     {
-        $this->setExpectedException('BadMethodCallException');
-        EnumInheritance::UNKNOWN();
+        $this->setExpectedException('InvalidArgumentException');
+        EnumInheritance::getByName('UNKNOWN');
+    }
+
+    public function testInstantiateUsingMagicMethod()
+    {
+        $enum = EnumInheritance::ONE();
+        $this->assertInstanceOf('MabeEnumTest\TestAsset\EnumInheritance', $enum);
+        $this->assertSame(EnumInheritance::ONE, $enum->getValue());
     }
 
     public function testAmbuguousConstantsThrowsLogicException()