handle class constant visibility added in PHP-7.1

Author: marc-mabe

src/Enum.php

@@ -296,9 +296,27 @@ private static function detectConstants($class)
     {
         if (!isset(self::$constants[$class])) {
             $reflection = new ReflectionClass($class);
-            $constants  = $reflection->getConstants();
+            $constants  = array();
+
+            do {
+                $scopeConstants = array();
+                if (PHP_VERSION_ID >= 70100) {
+                    // Since PHP-7.1 visibility modifiers are allowed for class constants
+                    // for enumerations we are only interested in public once.
+                    foreach ($reflection->getReflectionConstants() as $reflConstant) {
+                        if ($reflConstant->isPublic()) {
+                            $scopeConstants[ $reflConstant->getName() ] = $reflConstant->getValue();
+                        }
+                    }
+                } else {
+                    // In PHP < 7.1 all class constants were public by definition
+                    $scopeConstants = $reflection->getConstants();
+                }
+
+                $constants = $scopeConstants + $constants;
+            } while (($reflection = $reflection->getParentClass()) && $reflection->name !== __CLASS__);
 
-            // values needs to be unique
+            // Detect ambiguous values and report names
             $ambiguous = array();
             foreach ($constants as $value) {
                 $names = array_keys($constants, $value, true);
@@ -315,11 +333,6 @@ private static function detectConstants($class)
                 );
             }
 
-            // This is required to make sure that constants of base classes will be the first
-            while (($reflection = $reflection->getParentClass()) && $reflection->name !== __CLASS__) {
-                $constants = $reflection->getConstants() + $constants;
-            }
-
             self::$constants[$class] = $constants;
         }
 

tests/MabeEnumTest/EnumTest.php

@@ -6,6 +6,8 @@
 use MabeEnumTest\TestAsset\EnumInheritance;
 use MabeEnumTest\TestAsset\EnumAmbiguous;
 use MabeEnumTest\TestAsset\EnumExtendedAmbiguous;
+use MabeEnumTest\TestAsset\ConstVisibilityEnum;
+use MabeEnumTest\TestAsset\ConstVisibilityEnumExtended;
 use PHPUnit_Framework_TestCase as TestCase;
 use ReflectionClass;
 
@@ -255,4 +257,32 @@ public function testHas()
         $this->assertTrue($enum->has(EnumBasic::ONE()));
         $this->assertTrue($enum->has(EnumBasic::ONE));
     }
+    
+    public function testConstVisibility()
+    {
+        if (PHP_VERSION_ID < 70100) {
+            $this->markTestSkipped('This test is for PHP-7.1 and upper only');
+        }
+
+        $constants = ConstVisibilityEnum::getConstants();
+        $this->assertSame(array(
+            'IPUB' => ConstVisibilityEnum::IPUB,
+            'PUB'  => ConstVisibilityEnum::PUB,
+        ), $constants);
+    }
+    
+    public function testConstVisibilityExtended()
+    {
+        if (PHP_VERSION_ID < 70100) {
+            $this->markTestSkipped('This test is for PHP-7.1 and upper only');
+        }
+
+        $constants = ConstVisibilityEnumExtended::getConstants();
+        $this->assertSame(array(
+            'IPUB'  => ConstVisibilityEnumExtended::IPUB,
+            'PUB'   => ConstVisibilityEnumExtended::PUB,
+            'IPUB2' => ConstVisibilityEnumExtended::IPUB2,
+            'PUB2'  => ConstVisibilityEnumExtended::PUB2,
+        ), $constants);
+    }
 }

tests/MabeEnumTest/TestAsset/ConstVisibilityEnum.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace MabeEnumTest\TestAsset;
+
+use MabeEnum\Enum;
+
+/**
+ * Unit tests for the class MabeEnum\Enum
+ *
+ * @link http://github.com/marc-mabe/php-enum for the canonical source repository
+ * @copyright Copyright (c) 2013 Marc Bennewitz
+ * @license http://github.com/marc-mabe/php-enum/blob/master/LICENSE.txt New BSD License
+ */
+class ConstVisibilityEnum extends Enum
+{
+    const IPUB = 'indirect public';
+    public const PUB = 'public';
+    protected const PRO = 'protected';
+    private const PRI = 'private';
+}

tests/MabeEnumTest/TestAsset/ConstVisibilityEnumExtended.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace MabeEnumTest\TestAsset;
+
+use MabeEnum\Enum;
+
+/**
+ * Unit tests for the class MabeEnum\Enum
+ *
+ * @link http://github.com/marc-mabe/php-enum for the canonical source repository
+ * @copyright Copyright (c) 2013 Marc Bennewitz
+ * @license http://github.com/marc-mabe/php-enum/blob/master/LICENSE.txt New BSD License
+ */
+class ConstVisibilityEnumExtended extends ConstVisibilityEnum
+{
+    const IPUB2 = 'indirect public extended';
+    public const PUB2 = 'public extended';
+    protected const PRO2 = 'protected extended';
+    private const PRI2 = 'private extended';
+}