GH-15723: add ReflectionConstant::getFileName()

Allow determining the name of the file that defined a constant, when the
constant was defined in userland code via `define()`. For constants defined by
PHP core or extensions, `false` is returned, matching the existing
`getFileName()` methods on other reflection classes.

Author: DanielEScherzer

Zend/zend_builtin_functions.c

@@ -549,6 +549,13 @@ ZEND_FUNCTION(define)
 	/* non persistent */
 	ZEND_CONSTANT_SET_FLAGS(&c, 0, PHP_USER_CONSTANT);
 	c.name = zend_string_copy(name);
+
+	zend_string *filename = zend_get_executed_filename_ex();
+	if (filename == NULL) {
+		c.filename = NULL;
+	} else {
+		c.filename = zend_string_copy(filename);
+	}
 	if (zend_register_constant(&c) == SUCCESS) {
 		RETURN_TRUE;
 	} else {

Zend/zend_constants.c

@@ -46,12 +46,18 @@ void free_zend_constant(zval *zv)
 		if (c->name) {
 			zend_string_release_ex(c->name, 0);
 		}
+		if (c->filename) {
+			zend_string_release_ex(c->filename, 0);
+		}
 		efree(c);
 	} else {
 		zval_internal_ptr_dtor(&c->value);
 		if (c->name) {
 			zend_string_release_ex(c->name, 1);
 		}
+		if (c->filename) {
+			zend_string_release_ex(c->filename, 1);
+		}
 		free(c);
 	}
 }
@@ -68,6 +74,9 @@ static void copy_zend_constant(zval *zv)
 
 	c = Z_PTR_P(zv);
 	c->name = zend_string_copy(c->name);
+	if (c->filename != NULL) {
+		c->filename = zend_string_copy(c->filename);
+	}
 	if (Z_TYPE(c->value) == IS_STRING) {
 		Z_STR(c->value) = zend_string_dup(Z_STR(c->value), 1);
 	}
@@ -123,6 +132,7 @@ ZEND_API void zend_register_null_constant(const char *name, size_t name_len, int
 	ZVAL_NULL(&c.value);
 	ZEND_CONSTANT_SET_FLAGS(&c, flags, module_number);
 	c.name = zend_string_init_interned(name, name_len, flags & CONST_PERSISTENT);
+	c.filename = NULL;
 	zend_register_constant(&c);
 }
 
@@ -133,6 +143,7 @@ ZEND_API void zend_register_bool_constant(const char *name, size_t name_len, boo
 	ZVAL_BOOL(&c.value, bval);
 	ZEND_CONSTANT_SET_FLAGS(&c, flags, module_number);
 	c.name = zend_string_init_interned(name, name_len, flags & CONST_PERSISTENT);
+	c.filename = NULL;
 	zend_register_constant(&c);
 }
 
@@ -143,6 +154,7 @@ ZEND_API void zend_register_long_constant(const char *name, size_t name_len, zen
 	ZVAL_LONG(&c.value, lval);
 	ZEND_CONSTANT_SET_FLAGS(&c, flags, module_number);
 	c.name = zend_string_init_interned(name, name_len, flags & CONST_PERSISTENT);
+	c.filename = NULL;
 	zend_register_constant(&c);
 }
 
@@ -154,6 +166,7 @@ ZEND_API void zend_register_double_constant(const char *name, size_t name_len, d
 	ZVAL_DOUBLE(&c.value, dval);
 	ZEND_CONSTANT_SET_FLAGS(&c, flags, module_number);
 	c.name = zend_string_init_interned(name, name_len, flags & CONST_PERSISTENT);
+	c.filename = NULL;
 	zend_register_constant(&c);
 }
 
@@ -165,6 +178,7 @@ ZEND_API void zend_register_stringl_constant(const char *name, size_t name_len,
 	ZVAL_STR(&c.value, zend_string_init_interned(strval, strlen, flags & CONST_PERSISTENT));
 	ZEND_CONSTANT_SET_FLAGS(&c, flags, module_number);
 	c.name = zend_string_init_interned(name, name_len, flags & CONST_PERSISTENT);
+	c.filename = NULL;
 	zend_register_constant(&c);
 }
 
@@ -502,6 +516,10 @@ ZEND_API zend_result zend_register_constant(zend_constant *c)
 	) {
 		zend_error(E_WARNING, "Constant %s already defined", ZSTR_VAL(name));
 		zend_string_release(c->name);
+		if (c->filename) {
+			zend_string_release(c->filename);
+			c->filename = NULL;
+		}
 		if (!persistent) {
 			zval_ptr_dtor_nogc(&c->value);
 		}

Zend/zend_constants.h

@@ -33,6 +33,7 @@
 typedef struct _zend_constant {
 	zval value;
 	zend_string *name;
+	zend_string *filename;
 } zend_constant;
 
 #define ZEND_CONSTANT_FLAGS(c) \

Zend/zend_execute_API.c

@@ -299,6 +299,9 @@ ZEND_API void zend_shutdown_executor_values(bool fast_shutdown)
 				if (c->name) {
 					zend_string_release_ex(c->name, 0);
 				}
+				if (c->filename) {
+					zend_string_release_ex(c->filename, 0);
+				}
 				efree(c);
 				zend_string_release_ex(key, 0);
 			} ZEND_HASH_MAP_FOREACH_END_DEL();

ext/reflection/php_reflection.c

@@ -7835,6 +7835,20 @@ ZEND_METHOD(ReflectionConstant, isDeprecated)
 	RETURN_BOOL(ZEND_CONSTANT_FLAGS(const_) & CONST_DEPRECATED);
 }
 
+ZEND_METHOD(ReflectionConstant, getFileName)
+{
+	reflection_object *intern;
+	zend_constant *const_;
+
+	ZEND_PARSE_PARAMETERS_NONE();
+
+	GET_REFLECTION_OBJECT_PTR(const_);
+	if (const_->filename != NULL) {
+		RETURN_STR_COPY(const_->filename);
+	}
+	RETURN_FALSE;
+}
+
 ZEND_METHOD(ReflectionConstant, __toString)
 {
 	reflection_object *intern;

ext/reflection/php_reflection.stub.php

@@ -914,5 +914,7 @@ public function getValue(): mixed {}
 
     public function isDeprecated(): bool {}
 
+    public function getFileName(): string|false {}
+
     public function __toString(): string {}
 }

ext/reflection/php_reflection_arginfo.h

@@ -0,0 +1,22 @@
+--TEST--
+ReflectionConstant::getFileName()
+--FILE--
+<?php
+
+include "included5.inc";
+
+$reflectionConstant = new ReflectionConstant('PHP_VERSION');
+var_dump($reflectionConstant->getFileName());
+
+define('IN_CURRENT_FILE', 42);
+$reflectionConstant = new ReflectionConstant('IN_CURRENT_FILE');
+var_dump($reflectionConstant->getFileName());
+
+$reflectionConstant = new ReflectionConstant('INCLUDED_CONSTANT');
+var_dump($reflectionConstant->getFileName());
+
+?>
+--EXPECTF--
+bool(false)
+string(%d) "%sReflectionConstant_getFileName.php"
+string(%d) "%sincluded5.inc"

ext/reflection/tests/ReflectionConstant_getFileName.phpt

@@ -0,0 +1,3 @@
+<?php
+define('INCLUDED_CONSTANT', 'Foo');
+?>