Skip to content

Commit a6fc677

Browse files
kocsismatenikic
kocsismate
authored and
nikic
committed
Add support for final constants
1 parent f43a19e commit a6fc677

File tree

11 files changed

+115
-14
lines changed

11 files changed

+115
-14
lines changed

‎Zend/tests/constants/final_constants/final_const1.phpt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
--TEST--
2+
Class constants support the final modifier
3+
--FILE--
4+
<?php
5+
6+
class Foo
7+
{
8+
final const A = "foo";
9+
final public const B = "foo";
10+
}
11+
12+
?>
13+
--EXPECT--

‎Zend/tests/constants/final_constants/final_const2.phpt

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
--TEST--
2+
Final class constants cannot be overridden
3+
--FILE--
4+
<?php
5+
6+
class Foo
7+
{
8+
final const A = "foo";
9+
}
10+
11+
class Bar extends Foo
12+
{
13+
const A = "bar";
14+
}
15+
16+
?>
17+
--EXPECTF--
18+
Fatal error: Bar::A cannot override final constant Foo::A in %s on line %d

‎Zend/tests/constants/final_constants/final_const3.phpt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
--TEST--
2+
Private class constants cannot be final
3+
--FILE--
4+
<?php
5+
6+
class Foo
7+
{
8+
private final const A = "foo";
9+
}
10+
11+
?>
12+
--EXPECTF--
13+
Fatal error: Private constant Foo::A cannot be final as it is never overridden in %s on line %d

‎Zend/tests/errmsg_038.phpt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ class test {
1010
echo "Done\n";
1111
?>
1212
--EXPECTF--
13-
Fatal error: Cannot declare property test::$var final, the final modifier is allowed only for methods and classes in %s on line %d
13+
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

‎Zend/zend_compile.c

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7270,7 +7270,7 @@ void zend_compile_prop_decl(zend_ast *ast, zend_ast *type_ast, uint32_t flags, z
72707270

72717271
if (flags & ZEND_ACC_FINAL) {
72727272
zend_error_noreturn(E_COMPILE_ERROR, "Cannot declare property %s::$%s final, "
7273-
"the final modifier is allowed only for methods and classes",
7273+
"the final modifier is allowed only for methods, classes, and class constants",
72747274
ZSTR_VAL(ce->name), ZSTR_VAL(name));
72757275
}
72767276

@@ -7358,10 +7358,17 @@ void zend_compile_class_const_decl(zend_ast *ast, uint32_t flags, zend_ast *attr
73587358
zend_string *doc_comment = doc_comment_ast ? zend_string_copy(zend_ast_get_str(doc_comment_ast)) : NULL;
73597359
zval value_zv;
73607360

7361-
if (UNEXPECTED(flags & (ZEND_ACC_STATIC|ZEND_ACC_ABSTRACT|ZEND_ACC_FINAL))) {
7361+
if (UNEXPECTED(flags & (ZEND_ACC_STATIC|ZEND_ACC_ABSTRACT))) {
73627362
zend_check_const_and_trait_alias_attr(flags, "constant");
73637363
}
73647364

7365+
if (UNEXPECTED((flags & ZEND_ACC_PRIVATE) && (flags & ZEND_ACC_FINAL))) {
7366+
zend_error_noreturn(
7367+
E_COMPILE_ERROR, "Private constant %s::%s cannot be final as it is never overridden",
7368+
ZSTR_VAL(ce->name), ZSTR_VAL(name)
7369+
);
7370+
}
7371+
73657372
zend_const_expr_to_zval(&value_zv, value_ast_ptr);
73667373
c = zend_declare_class_constant_ex(ce, name, &value_zv, flags, doc_comment);
73677374

‎Zend/zend_inheritance.c

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1337,6 +1337,13 @@ static void do_inherit_class_constant(zend_string *name, zend_class_constant *pa
13371337
zend_error_noreturn(E_COMPILE_ERROR, "Access level to %s::%s must be %s (as in class %s)%s",
13381338
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");
13391339
}
1340+
1341+
if (UNEXPECTED((ZEND_CLASS_CONST_FLAGS(parent_const) & ZEND_ACC_FINAL))) {
1342+
zend_error_noreturn(
1343+
E_COMPILE_ERROR, "%s::%s cannot override final constant %s::%s",
1344+
ZSTR_VAL(ce->name), ZSTR_VAL(name), ZSTR_VAL(parent_const->ce->name), ZSTR_VAL(name)
1345+
);
1346+
}
13401347
} else if (!(ZEND_CLASS_CONST_FLAGS(parent_const) & ZEND_ACC_PRIVATE)) {
13411348
if (Z_TYPE(parent_const->value) == IS_CONSTANT_AST) {
13421349
ce->ce_flags &= ~ZEND_ACC_CONSTANTS_UPDATED;

‎ext/reflection/php_reflection.c

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3831,6 +3831,12 @@ ZEND_METHOD(ReflectionClassConstant, isProtected)
38313831
}
38323832
/* }}} */
38333833

3834+
/* Returns whether this constant is final */
3835+
ZEND_METHOD(ReflectionClassConstant, isFinal)
3836+
{
3837+
_class_constant_check_flag(INTERNAL_FUNCTION_PARAM_PASSTHRU, ZEND_ACC_FINAL);
3838+
}
3839+
38343840
/* {{{ Returns a bitfield of the access modifiers for this constant */
38353841
ZEND_METHOD(ReflectionClassConstant, getModifiers)
38363842
{

‎ext/reflection/php_reflection.stub.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -475,6 +475,8 @@ public function isPrivate(): bool {}
475475
/** @tentative-return-type */
476476
public function isProtected(): bool {}
477477

478+
public function isFinal(): bool {}
479+
478480
/** @tentative-return-type */
479481
public function getModifiers(): int {}
480482

‎ext/reflection/php_reflection_arginfo.h

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/* This is a generated file, edit the .stub.php file instead.
2-
* Stub hash: d8e686125cf213e019c1d706867e3c178fa057d2 */
2+
* Stub hash: 2564122a201ca462ee35ead1562c94da3ea3c8a3 */
33

44
ZEND_BEGIN_ARG_WITH_TENTATIVE_RETURN_TYPE_INFO_EX(arginfo_class_Reflection_getModifierNames, 0, 1, IS_ARRAY, 0)
55
ZEND_ARG_TYPE_INFO(0, modifiers, IS_LONG, 0)
@@ -396,6 +396,8 @@ ZEND_END_ARG_INFO()
396396

397397
#define arginfo_class_ReflectionClassConstant_isProtected arginfo_class_ReflectionFunctionAbstract_inNamespace
398398

399+
#define arginfo_class_ReflectionClassConstant_isFinal arginfo_class_ReflectionFunctionAbstract_hasTentativeReturnType
400+
399401
#define arginfo_class_ReflectionClassConstant_getModifiers arginfo_class_ReflectionFunctionAbstract_getNumberOfParameters
400402

401403
#define arginfo_class_ReflectionClassConstant_getDeclaringClass arginfo_class_ReflectionMethod_getDeclaringClass
@@ -736,6 +738,7 @@ ZEND_METHOD(ReflectionClassConstant, getValue);
736738
ZEND_METHOD(ReflectionClassConstant, isPublic);
737739
ZEND_METHOD(ReflectionClassConstant, isPrivate);
738740
ZEND_METHOD(ReflectionClassConstant, isProtected);
741+
ZEND_METHOD(ReflectionClassConstant, isFinal);
739742
ZEND_METHOD(ReflectionClassConstant, getModifiers);
740743
ZEND_METHOD(ReflectionClassConstant, getDeclaringClass);
741744
ZEND_METHOD(ReflectionClassConstant, getDocComment);
@@ -1015,6 +1018,7 @@ static const zend_function_entry class_ReflectionClassConstant_methods[] = {
10151018
ZEND_ME(ReflectionClassConstant, isPublic, arginfo_class_ReflectionClassConstant_isPublic, ZEND_ACC_PUBLIC)
10161019
ZEND_ME(ReflectionClassConstant, isPrivate, arginfo_class_ReflectionClassConstant_isPrivate, ZEND_ACC_PUBLIC)
10171020
ZEND_ME(ReflectionClassConstant, isProtected, arginfo_class_ReflectionClassConstant_isProtected, ZEND_ACC_PUBLIC)
1021+
ZEND_ME(ReflectionClassConstant, isFinal, arginfo_class_ReflectionClassConstant_isFinal, ZEND_ACC_PUBLIC)
10181022
ZEND_ME(ReflectionClassConstant, getModifiers, arginfo_class_ReflectionClassConstant_getModifiers, ZEND_ACC_PUBLIC)
10191023
ZEND_ME(ReflectionClassConstant, getDeclaringClass, arginfo_class_ReflectionClassConstant_getDeclaringClass, ZEND_ACC_PUBLIC)
10201024
ZEND_ME(ReflectionClassConstant, getDocComment, arginfo_class_ReflectionClassConstant_getDocComment, ZEND_ACC_PUBLIC)

‎ext/reflection/tests/ReflectionClassConstant_basic1.phpt

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ function reflectClassConstant($base, $constant) {
2020
var_dump($constInfo->isPrivate());
2121
echo "isProtected():\n";
2222
var_dump($constInfo->isProtected());
23+
echo "isFinal():\n";
24+
var_dump($constInfo->isFinal());
2325
echo "getModifiers():\n";
2426
var_dump($constInfo->getModifiers());
2527
echo "getDeclaringClass():\n";
@@ -34,12 +36,14 @@ class TestClass {
3436
/** Another doc comment */
3537
protected const PROT = 4;
3638
private const PRIV = "keepOut";
39+
public final const FINAL = "foo";
3740
}
3841
$instance = new TestClass();
3942

4043
reflectClassConstant("TestClass", "PUB");
4144
reflectClassConstant("TestClass", "PROT");
4245
reflectClassConstant("TestClass", "PRIV");
46+
reflectClassConstant("TestClass", "FINAL");
4347
reflectClassConstant($instance, "PRIV");
4448
reflectClassConstant($instance, "BAD_CONST");
4549

@@ -61,6 +65,8 @@ isPrivate():
6165
bool(false)
6266
isProtected():
6367
bool(false)
68+
isFinal():
69+
bool(false)
6470
getModifiers():
6571
int(1)
6672
getDeclaringClass():
@@ -88,6 +94,8 @@ isPrivate():
8894
bool(false)
8995
isProtected():
9096
bool(true)
97+
isFinal():
98+
bool(false)
9199
getModifiers():
92100
int(2)
93101
getDeclaringClass():
@@ -115,6 +123,8 @@ isPrivate():
115123
bool(true)
116124
isProtected():
117125
bool(false)
126+
isFinal():
127+
bool(false)
118128
getModifiers():
119129
int(4)
120130
getDeclaringClass():
@@ -125,6 +135,35 @@ object(ReflectionClass)#3 (1) {
125135
getDocComment():
126136
bool(false)
127137

138+
**********************************
139+
**********************************
140+
Reflecting on class constant TestClass::FINAL
141+
142+
__toString():
143+
string(41) "Constant [ public string FINAL ] { foo }
144+
"
145+
getName():
146+
string(5) "FINAL"
147+
getValue():
148+
string(3) "foo"
149+
isPublic():
150+
bool(true)
151+
isPrivate():
152+
bool(false)
153+
isProtected():
154+
bool(false)
155+
isFinal():
156+
bool(true)
157+
getModifiers():
158+
int(1)
159+
getDeclaringClass():
160+
object(ReflectionClass)#3 (1) {
161+
["name"]=>
162+
string(9) "TestClass"
163+
}
164+
getDocComment():
165+
bool(false)
166+
128167
**********************************
129168
**********************************
130169
Reflecting on class constant TestClass::PRIV
@@ -142,6 +181,8 @@ isPrivate():
142181
bool(true)
143182
isProtected():
144183
bool(false)
184+
isFinal():
185+
bool(false)
145186
getModifiers():
146187
int(4)
147188
getDeclaringClass():

0 commit comments

Comments
 (0)