Add support for final constants

kocsismate · kocsismate · commit 156156ce78b3 · 2021-07-03T10:02:56.000+02:00
diff --git a/Zend/tests/constants/final_constants/final_const1.phpt b/Zend/tests/constants/final_constants/final_const1.phpt
@@ -0,0 +1,13 @@
+--TEST--
+Class constants support the final modifier
+--FILE--
+<?php
+
+class Foo
+{
+    final const A = "foo";
+    final public const B = "foo";
+}
+
+?>
+--EXPECT--
diff --git a/Zend/tests/constants/final_constants/final_const2.phpt b/Zend/tests/constants/final_constants/final_const2.phpt
@@ -0,0 +1,18 @@
+--TEST--
+Final class constants cannot be overridden
+--FILE--
+<?php
+
+class Foo
+{
+    final const A = "foo";
+}
+
+class Bar extends Foo
+{
+    const A = "bar";
+}
+
+?>
+--EXPECTF--
+Fatal error: Bar::A cannot override final constant Foo::A in %s on line %d
diff --git a/Zend/tests/constants/final_constants/final_const3.phpt b/Zend/tests/constants/final_constants/final_const3.phpt
@@ -0,0 +1,13 @@
+--TEST--
+Private class constants cannot be final
+--FILE--
+<?php
+
+class Foo
+{
+    private final const A = "foo";
+}
+
+?>
+--EXPECTF--
+Fatal error: Private constant Foo::A cannot be final as it is never overridden in %s on line %d
diff --git a/Zend/tests/errmsg_038.phpt b/Zend/tests/errmsg_038.phpt
@@ -10,4 +10,4 @@ class test {
 echo "Done\n";
 ?>
 --EXPECTF--
-Fatal error: Cannot declare property test::$var final, the final modifier is allowed only for methods and classes in %s on line %d
+Fatal error: Cannot declare property test::$var final, the final modifier is allowed only for methods, classes, and class constants in %s on line %d
diff --git a/Zend/zend_compile.c b/Zend/zend_compile.c
@@ -7212,7 +7212,7 @@ void zend_compile_prop_decl(zend_ast *ast, zend_ast *type_ast, uint32_t flags, z
 
 		if (flags & ZEND_ACC_FINAL) {
 			zend_error_noreturn(E_COMPILE_ERROR, "Cannot declare property %s::$%s final, "
-				"the final modifier is allowed only for methods and classes",
+				"the final modifier is allowed only for methods, classes, and class constants",
 				ZSTR_VAL(ce->name), ZSTR_VAL(name));
 		}
 
@@ -7300,10 +7300,17 @@ void zend_compile_class_const_decl(zend_ast *ast, uint32_t flags, zend_ast *attr
 		zend_string *doc_comment = doc_comment_ast ? zend_string_copy(zend_ast_get_str(doc_comment_ast)) : NULL;
 		zval value_zv;
 
-		if (UNEXPECTED(flags & (ZEND_ACC_STATIC|ZEND_ACC_ABSTRACT|ZEND_ACC_FINAL))) {
+		if (UNEXPECTED(flags & (ZEND_ACC_STATIC|ZEND_ACC_ABSTRACT))) {
 			zend_check_const_and_trait_alias_attr(flags, "constant");
 		}
 
+		if (UNEXPECTED((flags & ZEND_ACC_PRIVATE) && (flags & ZEND_ACC_FINAL))) {
+			zend_error_noreturn(
+				E_COMPILE_ERROR, "Private constant %s::%s cannot be final as it is never overridden",
+				ZSTR_VAL(ce->name), ZSTR_VAL(name)
+			);
+		}
+
 		zend_const_expr_to_zval(&value_zv, value_ast_ptr);
 		c = zend_declare_class_constant_ex(ce, name, &value_zv, flags, doc_comment);
 
diff --git a/Zend/zend_inheritance.c b/Zend/zend_inheritance.c
@@ -1204,6 +1204,13 @@ static void do_inherit_class_constant(zend_string *name, zend_class_constant *pa
 			zend_error_noreturn(E_COMPILE_ERROR, "Access level to %s::%s must be %s (as in class %s)%s",
 				ZSTR_VAL(ce->name), ZSTR_VAL(name), zend_visibility_string(ZEND_CLASS_CONST_FLAGS(parent_const)), ZSTR_VAL(parent_const->ce->name), (ZEND_CLASS_CONST_FLAGS(parent_const) & ZEND_ACC_PUBLIC) ? "" : " or weaker");
 		}
+
+		if (UNEXPECTED((ZEND_CLASS_CONST_FLAGS(parent_const) & ZEND_ACC_FINAL))) {
+			zend_error_noreturn(
+				E_COMPILE_ERROR, "%s::%s cannot override final constant %s::%s",
+				ZSTR_VAL(ce->name), ZSTR_VAL(name), ZSTR_VAL(parent_const->ce->name), ZSTR_VAL(name)
+			);
+		}
 	} else if (!(ZEND_CLASS_CONST_FLAGS(parent_const) & ZEND_ACC_PRIVATE)) {
 		if (Z_TYPE(parent_const->value) == IS_CONSTANT_AST) {
 			ce->ce_flags &= ~ZEND_ACC_CONSTANTS_UPDATED;
diff --git a/ext/reflection/php_reflection.c b/ext/reflection/php_reflection.c
@@ -3784,6 +3784,12 @@ ZEND_METHOD(ReflectionClassConstant, isProtected)
 }
 /* }}} */
 
+/* Returns whether this constant is final */
+ZEND_METHOD(ReflectionClassConstant, isFinal)
+{
+	_class_constant_check_flag(INTERNAL_FUNCTION_PARAM_PASSTHRU, ZEND_ACC_FINAL);
+}
+
 /* {{{ Returns a bitfield of the access modifiers for this constant */
 ZEND_METHOD(ReflectionClassConstant, getModifiers)
 {
diff --git a/ext/reflection/php_reflection.stub.php b/ext/reflection/php_reflection.stub.php
@@ -475,6 +475,8 @@ public function isPrivate(): bool {}
     /** @tentative-return-type */
     public function isProtected(): bool {}
 
+    public function isFinal(): bool {}
+
     /** @tentative-return-type */
     public function getModifiers(): int {}
 
diff --git a/ext/reflection/php_reflection_arginfo.h b/ext/reflection/php_reflection_arginfo.h
@@ -1,5 +1,5 @@
 /* This is a generated file, edit the .stub.php file instead.
- * Stub hash: e66c459f457f71cb677a93652364ab7e81be8b0e */
+ * Stub hash: 7b88d88091244509d767a5146507ba0df17967e8 */
 
 ZEND_BEGIN_ARG_WITH_TENTATIVE_RETURN_TYPE_INFO_EX(arginfo_class_Reflection_getModifierNames, 0, 1, IS_ARRAY, 0)
 	ZEND_ARG_TYPE_INFO(0, modifiers, IS_LONG, 0)
@@ -396,6 +396,8 @@ ZEND_END_ARG_INFO()
 
 #define arginfo_class_ReflectionClassConstant_isProtected arginfo_class_ReflectionFunctionAbstract_inNamespace
 
+#define arginfo_class_ReflectionClassConstant_isFinal arginfo_class_ReflectionFunctionAbstract_hasTentativeReturnType
+
 #define arginfo_class_ReflectionClassConstant_getModifiers arginfo_class_ReflectionFunctionAbstract_getNumberOfParameters
 
 #define arginfo_class_ReflectionClassConstant_getDeclaringClass arginfo_class_ReflectionMethod_getDeclaringClass
@@ -734,6 +736,7 @@ ZEND_METHOD(ReflectionClassConstant, getValue);
 ZEND_METHOD(ReflectionClassConstant, isPublic);
 ZEND_METHOD(ReflectionClassConstant, isPrivate);
 ZEND_METHOD(ReflectionClassConstant, isProtected);
+ZEND_METHOD(ReflectionClassConstant, isFinal);
 ZEND_METHOD(ReflectionClassConstant, getModifiers);
 ZEND_METHOD(ReflectionClassConstant, getDeclaringClass);
 ZEND_METHOD(ReflectionClassConstant, getDocComment);
@@ -1012,6 +1015,7 @@ static const zend_function_entry class_ReflectionClassConstant_methods[] = {
 	ZEND_ME(ReflectionClassConstant, isPublic, arginfo_class_ReflectionClassConstant_isPublic, ZEND_ACC_PUBLIC)
 	ZEND_ME(ReflectionClassConstant, isPrivate, arginfo_class_ReflectionClassConstant_isPrivate, ZEND_ACC_PUBLIC)
 	ZEND_ME(ReflectionClassConstant, isProtected, arginfo_class_ReflectionClassConstant_isProtected, ZEND_ACC_PUBLIC)
+	ZEND_ME(ReflectionClassConstant, isFinal, arginfo_class_ReflectionClassConstant_isFinal, ZEND_ACC_PUBLIC)
 	ZEND_ME(ReflectionClassConstant, getModifiers, arginfo_class_ReflectionClassConstant_getModifiers, ZEND_ACC_PUBLIC)
 	ZEND_ME(ReflectionClassConstant, getDeclaringClass, arginfo_class_ReflectionClassConstant_getDeclaringClass, ZEND_ACC_PUBLIC)
 	ZEND_ME(ReflectionClassConstant, getDocComment, arginfo_class_ReflectionClassConstant_getDocComment, ZEND_ACC_PUBLIC)
diff --git a/ext/reflection/tests/ReflectionClassConstant_basic1.phpt b/ext/reflection/tests/ReflectionClassConstant_basic1.phpt
@@ -20,6 +20,8 @@ function reflectClassConstant($base, $constant) {
     var_dump($constInfo->isPrivate());
     echo "isProtected():\n";
     var_dump($constInfo->isProtected());
+    echo "isFinal():\n";
+    var_dump($constInfo->isFinal());
     echo "getModifiers():\n";
     var_dump($constInfo->getModifiers());
     echo "getDeclaringClass():\n";
@@ -34,12 +36,14 @@ class TestClass {
     /** Another doc comment */
     protected const PROT = 4;
     private const PRIV = "keepOut";
+    public final const FINAL = "foo";
 }
 $instance = new TestClass();
 
 reflectClassConstant("TestClass", "PUB");
 reflectClassConstant("TestClass", "PROT");
 reflectClassConstant("TestClass", "PRIV");
+reflectClassConstant("TestClass", "FINAL");
 reflectClassConstant($instance, "PRIV");
 reflectClassConstant($instance, "BAD_CONST");
 
@@ -61,6 +65,8 @@ isPrivate():
 bool(false)
 isProtected():
 bool(false)
+isFinal():
+bool(false)
 getModifiers():
 int(1)
 getDeclaringClass():
@@ -88,6 +94,8 @@ isPrivate():
 bool(false)
 isProtected():
 bool(true)
+isFinal():
+bool(false)
 getModifiers():
 int(2)
 getDeclaringClass():
@@ -115,6 +123,8 @@ isPrivate():
 bool(true)
 isProtected():
 bool(false)
+isFinal():
+bool(false)
 getModifiers():
 int(4)
 getDeclaringClass():
@@ -125,6 +135,35 @@ object(ReflectionClass)#3 (1) {
 getDocComment():
 bool(false)
 
+**********************************
+**********************************
+Reflecting on class constant TestClass::FINAL
+
+__toString():
+string(41) "Constant [ public string FINAL ] { foo }
+"
+getName():
+string(5) "FINAL"
+getValue():
+string(3) "foo"
+isPublic():
+bool(true)
+isPrivate():
+bool(false)
+isProtected():
+bool(false)
+isFinal():
+bool(true)
+getModifiers():
+int(1)
+getDeclaringClass():
+object(ReflectionClass)#3 (1) {
+  ["name"]=>
+  string(9) "TestClass"
+}
+getDocComment():
+bool(false)
+
 **********************************
 **********************************
 Reflecting on class constant TestClass::PRIV
@@ -142,6 +181,8 @@ isPrivate():
 bool(true)
 isProtected():
 bool(false)
+isFinal():
+bool(false)
 getModifiers():
 int(4)
 getDeclaringClass():
diff --git a/tests/classes/constants_visibility_007.phpt b/tests/classes/constants_visibility_007.phpt

Original file line number	Diff line number	Diff line change
`@@ -3784,6 +3784,12 @@ ZEND_METHOD(ReflectionClassConstant, isProtected)`
`3784`	`3784`	`}`
`3785`	`3785`	`/* }}} */`
`3786`	`3786`
	`3787`	`+/* Returns whether this constant is final */`
	`3788`	`+ZEND_METHOD(ReflectionClassConstant, isFinal)`
	`3789`	`+{`
	`3790`	`+ _class_constant_check_flag(INTERNAL_FUNCTION_PARAM_PASSTHRU, ZEND_ACC_FINAL);`
	`3791`	`+}`
	`3792`	`+`
`3787`	`3793`	`/* {{{ Returns a bitfield of the access modifiers for this constant */`
`3788`	`3794`	`ZEND_METHOD(ReflectionClassConstant, getModifiers)`
`3789`	`3795`	`{`