Now the $value property is private that minifies checks if the vaue is valid and helps performance

updated README

Author: marc-mabe

README.md

@@ -28,21 +28,61 @@ It's an abstract class that needs to be extended to use it.
 
 * It's not build-in PHP and requires pecl extension
 * SplEnum is too much magic under the hod
-* SplEnum hasn't strict comparison
 
 
 # API
 
-    MabeEnum_Enum
+    abstract class MabeEnum_Enum
     {
-        protected $value = null;
-        public function __construct($value = null);
+        /**
+         * Constructor
+         * @param scalar $value             The enum value to select
+         * @throws InvalidArgumentException On unknwon value
+         */
+        public function __construct($value);
+    
+        /**
+         * Returns an assoc array of defined constant names and the values
+         * @return array
+         */
         final public function getConstants();
-        final public function setValue($value);
-        final public function getValue()
-        final public function setName($name);
+    
+        /**
+         * Get the selected value
+         * @return scalar
+         */
+        final public function getValue();
+    
+        /**
+         * Get the constant name of the selected value
+         * @return string
+         */
         final public function getName();
-        final public function __toString(); // Alias of getValue()
+    
+        /**
+         * Get the ordinal number of the selected value
+         * @return int
+         */
+        final public function getOrdinal();
+    
+        /**
+         * Get the selected value as string
+         * (This will be called automatically on converting into a string)
+         * @return string
+         */
+        final public function __toString();
+    
+        /**
+         * Instantiate a new enum were the selected value
+         * is the constant name of the called method name
+         * (This will be called automatically on calling static method)
+         * NOTE: THIS WILL WORK FOR PHP >= 5.3 ONLY
+         * @param string $name            The name of the constant to instantiate
+         * @param array  $args            This should be an empty array (no arguments)
+         * @throws BadMethodCallException If the called method hasn't the same name as a constant
+         * @return MabeEnum_Enum          The instantiated enum
+         */
+        final public static __callStatic($name, array $args);
     }
 
 
@@ -94,30 +134,27 @@ It's an abstract class that needs to be extended to use it.
         const INACTIVE = 0;
         const ACTIVE   = 1;
         const DELETED  = 2;
-
-        // default value
-        protected $value = self::INACTIVE;
     }
-
+    
     class User
     {
         protected $status;
-
+    
         public function setStatus(UserStatusEnum $status)
         {
             $this->status = $status;
         }
-
+    
         public function getStatus()
         {
             if (!$this->status) {
                 // init default status
-                $this->status = new UserStatusEnum();
+                $this->status = new UserStatusEnum(UserStatusEnum::INACTIVE);
             }
             return $this->status;
         }
     }
-
+    
     $user = new User();
     echo 'Default user status: ' . $user->getStatus() . '(' . $user->getStatus()->getValue() . ')' . PHP_EOL;
     $user->setStatus(new UserStatusEnum(UserStatusEnum::ACTIVE));
@@ -161,63 +198,40 @@ value.
     {
         const ONE = 1;
         const TWO = 2;
-        protected $value = self::ONE;
+    
+        public function __construct($value = self::ONE)
+        {
+            parent::__construct($value);
+        }
     }
 
-## Enum without a default value
-
-Don't define a ```$value``` to not define a default value if none of your
-constant values has ```NULL``` as value.
+## Inheritance
 
-That's because ```$value``` was defined as ```NULL``` in the base class and
-no constant assignable to the default value.
+It's also possible to extend other enumerations.
 
-    class MyEnumWithoutDefaultValue extends MabeEnum_Enum
+    class MyEnum extends MabeEnum_Enum
     {
         const ONE = 1;
         const TWO = 2;
     }
-
-* No argument on constructor results in an InvalidArgumentException
-
-## Constant with NULL as value
-
-Because ```$value``` property is defined as ```NULL``` a constant with
-```NULL```  as value gets the default value automatically.
-
-    class MyEnumWithNullAsDefaultValue extends MabeEnum_Enum
+    
+    class EnumInheritance extends MyEnum
     {
-        const NONE = null;
-        const ONE  = 1;
-        const TWO  = 2;
+        const INHERITANCE = 'Inheritance';
     }
 
-To disable this behavior simply define ```$value``` to a value not assignable
-to a constant.
+## Simplified instantiation
 
-    class MyEnumWithoutNullAsDefaultValue extends MabeEnum_Enum
-    {
-        const NONE = null;
-        const ONE  = 1;
-        const TWO  = 2;
-        protected $value = -1;
-    }
-
-## Inheritance
-
-It's also possible to extend other enumerations.
+With PHP >= 5.3 it possible to call one of the defined constants like a method
+and you will get the instantiated enum as a result.
 
     class MyEnum extends MabeEnum_Enum
     {
         const ONE = 1;
         const TWO = 2;
     }
-
-    class EnumInheritance extends MyEnum
-    {
-        const INHERITACE = 'Inheritance';
-    }
-
+    
+    $enum = MyEnum::ONE();
 
 # New BSD License
 

src/MabeEnum/Enum.php

@@ -11,29 +11,29 @@ abstract class MabeEnum_Enum
 {
     /**
      * The current selected value
-     * @var scalar
+     * @var null|scalar
      */
-    protected $value = null;
+    private $value;
 
     /**
      * The ordinal number of the value
      * @var null|int
      */
-    private $ordinal = null;
+    private $ordinal;
 
     /**
      * An array of available constants
-     * @var array
+     * @var null|array
      */
-    private $constants = null;
+    private $constants;
 
     /**
      * Constructor
      * 
-     * @param mixed $value The value to select
+     * @param scalar $value The value to select
      * @throws InvalidArgumentException
      */
-    public function __construct($value = null)
+    public function __construct($value)
     {
         $reflectionClass = new ReflectionClass($this);
         $constants       = $reflectionClass->getConstants();
@@ -46,11 +46,6 @@ public function __construct($value = null)
 
         // TODO: Check that constant values are equal (non strict comparison)
 
-        // use the default value
-        if (func_num_args() == 0) {
-            $value = $this->value;
-        }
-
         // find and set the given value
         // set the defined value because of non strict comparison
         $const = array_search($value, $this->constants);
@@ -98,15 +93,13 @@ final public function getOrdinal()
         $value   = $this->value;
         foreach ($this->constants as $constValue) {
             if ($value === $constValue) {
-                $this->ordinal = $ordinal;
-                return $ordinal;
+                break;
             }
             ++$ordinal;
         }
 
-        throw new RuntimeException(
-            "Current value '{$value}' isn't defined within this '" . get_class($this) . "'"
-        );
+        $this->ordinal = $ordinal;
+        return $ordinal;
     }
 
     /**

tests/MabeEnumTest/EnumTest.php

@@ -40,25 +40,6 @@ public function testToStringMagicMethodReturnsValueAsString()
         $this->assertSame('1', $enum->__toString());
     }
 
-    public function testEnumWithNullAsDefaultValue()
-    {
-        $enum = new MabeEnumTest_TestAsset_EnumWithNullAsDefaultValue();
-
-        $this->assertSame(array(
-            'NONE' => null,
-            'ONE'  => 1,
-            'TWO'  => 2,
-        ), $enum->getConstants());
-
-        $this->assertNull($enum->getValue());
-    }
-
-    public function testEnumWithoutDefaultValue()
-    {
-        $this->setExpectedException('InvalidArgumentException');
-        new MabeEnumTest_TestAsset_EnumWithoutDefaultValue();
-    }
-
     public function testEnumInheritance()
     {
         $enum = new MabeEnumTest_TestAsset_EnumInheritance(MabeEnumTest_TestAsset_EnumInheritance::ONE);
@@ -89,26 +70,19 @@ public function testConstuctorNonStrictValue()
         $this->assertSame(1, $enum->getOrdinal());
     }
 
+    public function testConstructorInvalidValueThrowsInvalidArgumentException()
+    {
+        $this->setExpectedException('InvalidArgumentException');
+        new MabeEnumTest_TestAsset_EnumWithoutDefaultValue('unknown');
+    }
+
     public function testCallingGetOrdinalTwoTimesWillResultTheSameValue()
     {
         $enum = new MabeEnumTest_TestAsset_EnumWithoutDefaultValue(MabeEnumTest_TestAsset_EnumWithoutDefaultValue::TWO);
         $this->assertSame(1, $enum->getOrdinal());
         $this->assertSame(1, $enum->getOrdinal());
     }
 
-    public function testGetOrdinalThrowsRuntimeExceptionOnUnknwonValue()
-    {
-        $enum = new MabeEnumTest_TestAsset_EnumWithDefaultValue();
-
-        // change the protected value property to an unknwon value
-        $reflectionValue = new ReflectionProperty($enum, 'value');
-        $reflectionValue->setAccessible(true);
-        $reflectionValue->setValue($enum, 'unknwonValue');
-
-        $this->setExpectedException('RuntimeException');
-        $enum->getOrdinal();
-    }
-
     public function testInstantiateUsingMagicMethod()
     {
         if (version_compare(PHP_VERSION, '5.3', '<')) {

tests/MabeEnumTest/TestAsset/EnumWithDefaultValue.php

@@ -11,5 +11,9 @@ class MabeEnumTest_TestAsset_EnumWithDefaultValue extends MabeEnum_Enum
 {
     const ONE = 1;
     const TWO = 2;
-    protected $value = 1;
+
+    public function __construct($value = self::ONE)
+    {
+        parent::__construct($value);
+    }
 }