Merge pull request #80 from marc-mabe/enum_get_by

renamed Enum::getBy[Name|Ordinal]() to Enum::by[Name|Ordinal]() and added Enum::byValue()

Author: marc-mabe

README.md

@@ -75,8 +75,8 @@ class UserStatus extends Enum
 // different ways to instantiate an enumerator
 $status = UserStatus::get(UserStatus::ACTIVE);
 $status = UserStatus::ACTIVE();
-$status = UserStatus::getByName('ACTIVE');
-$status = UserStatus::getByOrdinal(1);
+$status = UserStatus::byName('ACTIVE');
+$status = UserStatus::byOrdinal(1);
 
 // available methods to get the selected entry
 $status->getValue();   // returns the selected constant value

src/Enum.php

@@ -169,6 +169,19 @@ final public static function get($value)
             return $value;
         }
 
+        return static::byValue($value);
+    }
+
+    /**
+     * Get an enumerator instance by the given value
+     *
+     * @param mixed $value
+     * @return static
+     * @throws InvalidArgumentException On an unknwon or invalid value
+     * @throws LogicException           On ambiguous constant values
+     */
+    final public static function byValue($value)
+    {
         $class     = get_called_class();
         $constants = self::detectConstants($class);
         $name      = array_search($value, $constants, true);
@@ -194,7 +207,7 @@ final public static function get($value)
      * @throws InvalidArgumentException On an invalid or unknown name
      * @throws LogicException           On ambiguous values
      */
-    final public static function getByName($name)
+    final public static function byName($name)
     {
         $name  = (string) $name;
         $class = get_called_class();
@@ -218,7 +231,7 @@ final public static function getByName($name)
      * @throws InvalidArgumentException On an invalid ordinal number
      * @throws LogicException           On ambiguous values
      */
-    final public static function getByOrdinal($ordinal)
+    final public static function byOrdinal($ordinal)
     {
         $ordinal   = (int) $ordinal;
         $class     = get_called_class();
@@ -239,6 +252,34 @@ final public static function getByOrdinal($ordinal)
         return self::$instances[$class][$name] = new $class(current($item), $ordinal);
     }
 
+    /**
+     * Get an enumerator instance by the given name
+     *
+     * @param string $name The name of the enumerator
+     * @return static
+     * @throws InvalidArgumentException On an invalid or unknown name
+     * @throws LogicException           On ambiguous values
+     * @deprecated
+     */
+    final public static function getByName($name)
+    {
+        return static::byName($name);
+    }
+
+    /**
+     * Get an enumeration instance by the given ordinal number
+     *
+     * @param int $ordinal The ordinal number or the enumerator
+     * @return static
+     * @throws InvalidArgumentException On an invalid ordinal number
+     * @throws LogicException           On ambiguous values
+     * @deprecated
+     */
+    final public static function getByOrdinal($ordinal)
+    {
+        return static::byOrdinal($ordinal);
+    }
+
     /**
      * Clear all instantiated enumerators of the called class
      *
@@ -260,7 +301,7 @@ final public static function clear()
      */
     final public static function getEnumerators()
     {
-        return array_map('self::getByName', array_keys(self::detectConstants(get_called_class())));
+        return array_map('self::byName', array_keys(self::detectConstants(get_called_class())));
     }
 
     /**
@@ -390,6 +431,6 @@ private static function detectConstants($class)
      */
     final public static function __callStatic($method, array $args)
     {
-        return self::getByName($method);
+        return self::byName($method);
     }
 }

src/EnumSet.php

@@ -125,7 +125,7 @@ public function current()
     {
         if ($this->valid()) {
             $enumeration = $this->enumeration;
-            return $enumeration::getByOrdinal($this->ordinal);
+            return $enumeration::byOrdinal($this->ordinal);
         }
 
         return null;
@@ -376,7 +376,7 @@ public function getValues()
         $enumeration = $this->enumeration;
         $values      = array();
         foreach ($this->getOrdinals() as $ord) {
-            $values[] = $enumeration::getByOrdinal($ord)->getValue();
+            $values[] = $enumeration::byOrdinal($ord)->getValue();
         }
         return $values;
     }
@@ -390,7 +390,7 @@ public function getNames()
         $enumeration = $this->enumeration;
         $names       = array();
         foreach ($this->getOrdinals() as $ord) {
-            $names[] = $enumeration::getByOrdinal($ord)->getName();
+            $names[] = $enumeration::byOrdinal($ord)->getName();
         }
         return $names;
     }
@@ -404,7 +404,7 @@ public function getEnumerators()
         $enumeration = $this->enumeration;
         $enumerators = array();
         foreach ($this->getOrdinals() as $ord) {
-            $enumerators[] = $enumeration::getByOrdinal($ord);
+            $enumerators[] = $enumeration::byOrdinal($ord);
         }
         return $enumerators;
     }

tests/MabeEnumTest/EnumSetTest.php

@@ -174,7 +174,7 @@ public function testInitEnumThrowsInvalidArgumentExceptionOnInvalidEnum()
     public function testIterateOutOfRangeIfLastOrdinalEnumIsSet()
     {
         $enumSet = new EnumSet('MabeEnumTest\TestAsset\EnumBasic');
-        $enum    = EnumBasic::getByOrdinal(count(EnumBasic::getConstants()) - 1);
+        $enum    = EnumBasic::byOrdinal(count(EnumBasic::getConstants()) - 1);
 
         $enumSet->attach($enum);
         $enumSet->rewind();
@@ -246,7 +246,7 @@ public function test65EnumerationsSet()
     {
         $enum = new EnumSet('MabeEnumTest\TestAsset\Enum65');
 
-        $this->assertNull($enum->attach(Enum65::getByOrdinal(64)));
+        $this->assertNull($enum->attach(Enum65::byOrdinal(64)));
         $enum->next();
         $this->assertTrue($enum->valid());
     }

tests/MabeEnumTest/EnumTest.php

@@ -193,28 +193,28 @@ public function testCallingGetOrdinalTwoTimesWillResultTheSameValue()
 
     public function testInstantiateUsingOrdinalNumber()
     {
-        $enum = EnumInheritance::getByOrdinal(16);
+        $enum = EnumInheritance::byOrdinal(16);
         $this->assertSame(16, $enum->getOrdinal());
         $this->assertSame('INHERITANCE', $enum->getName());
     }
 
     public function testInstantiateUsingInvalidOrdinalNumberThrowsInvalidArgumentException()
     {
         $this->setExpectedException('InvalidArgumentException');
-        EnumInheritance::getByOrdinal(17);
+        EnumInheritance::byOrdinal(17);
     }
 
     public function testInstantiateByName()
     {
-        $enum = EnumInheritance::getByName('ONE');
+        $enum = EnumInheritance::byName('ONE');
         $this->assertInstanceOf('MabeEnumTest\TestAsset\EnumInheritance', $enum);
         $this->assertSame(EnumInheritance::ONE, $enum->getValue());
     }
 
     public function testInstantiateByUnknownNameThrowsInvalidArgumentException()
     {
         $this->setExpectedException('InvalidArgumentException');
-        EnumInheritance::getByName('UNKNOWN');
+        EnumInheritance::byName('UNKNOWN');
     }
 
     public function testInstantiateUsingMagicMethod()