Skip to content

Commit 054f3e3

Browse files
reezereeze
committed
Implemented FR #61602 Allow access to name of constant used as default value
1 parent 3bf53aa commit 054f3e3

5 files changed

+193
-20
lines changed

‎NEWS

+2
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,8 @@ PHP NEWS
100100
bytes). (Nikita Popov)
101101

102102
- Reflection:
103+
. Implemented FR #61602 (Allow access to the name of constant
104+
used as function/method parameter's default value). (reeze.xia@gmail.com)
103105
. Fixed bug #60968 (Late static binding doesn't work with
104106
ReflectionMethod::invokeArgs()). (Laruence)
105107

‎ext/reflection/php_reflection.c

+84-20
Original file line numberDiff line numberDiff line change
@@ -1457,6 +1457,57 @@ static void _reflection_export(INTERNAL_FUNCTION_PARAMETERS, zend_class_entry *c
14571457
}
14581458
/* }}} */
14591459

1460+
/* {{{ _reflection_param_get_default_param */
1461+
static parameter_reference *_reflection_param_get_default_param(INTERNAL_FUNCTION_PARAMETERS)
1462+
{
1463+
reflection_object *intern;
1464+
parameter_reference *param;
1465+
1466+
if (zend_parse_parameters_none() == FAILURE) {
1467+
return NULL;
1468+
}
1469+
1470+
GET_REFLECTION_OBJECT_PTR(param);
1471+
1472+
if (param->fptr->type != ZEND_USER_FUNCTION)
1473+
{
1474+
zend_throw_exception_ex(reflection_exception_ptr, 0 TSRMLS_CC, "Cannot determine default value for internal functions");
1475+
return NULL;
1476+
}
1477+
1478+
if (param->offset < param->required) {
1479+
zend_throw_exception_ex(reflection_exception_ptr, 0 TSRMLS_CC, "Parameter is not optional");
1480+
return NULL;
1481+
}
1482+
1483+
return param;
1484+
}
1485+
/* }}} */
1486+
1487+
/* {{{ _reflection_param_get_default_precv */
1488+
static zend_op *_reflection_param_get_default_precv(INTERNAL_FUNCTION_PARAMETERS)
1489+
{
1490+
zend_op *precv;
1491+
parameter_reference *param = _reflection_param_get_default_param(INTERNAL_FUNCTION_PARAM_PASSTHRU);
1492+
1493+
if (zend_parse_parameters_none() == FAILURE) {
1494+
return NULL;
1495+
}
1496+
1497+
if(!param) {
1498+
return NULL;
1499+
}
1500+
1501+
precv = _get_recv_op((zend_op_array*)param->fptr, param->offset);
1502+
if (!precv || precv->opcode != ZEND_RECV_INIT || precv->op2_type == IS_UNUSED) {
1503+
zend_throw_exception_ex(reflection_exception_ptr, 0 TSRMLS_CC, "Internal error");
1504+
return NULL;
1505+
}
1506+
1507+
return precv;
1508+
}
1509+
/* }}} */
1510+
14601511
/* {{{ Preventing __clone from being called */
14611512
ZEND_METHOD(reflection, __clone)
14621513
{
@@ -2535,27 +2586,10 @@ ZEND_METHOD(reflection_parameter, isDefaultValueAvailable)
25352586
Returns the default value of this parameter or throws an exception */
25362587
ZEND_METHOD(reflection_parameter, getDefaultValue)
25372588
{
2538-
reflection_object *intern;
2539-
parameter_reference *param;
2540-
zend_op *precv;
2589+
parameter_reference *param = _reflection_param_get_default_param(INTERNAL_FUNCTION_PARAM_PASSTHRU);
2590+
zend_op *precv = _reflection_param_get_default_precv(INTERNAL_FUNCTION_PARAM_PASSTHRU);
25412591

2542-
if (zend_parse_parameters_none() == FAILURE) {
2543-
return;
2544-
}
2545-
GET_REFLECTION_OBJECT_PTR(param);
2546-
2547-
if (param->fptr->type != ZEND_USER_FUNCTION)
2548-
{
2549-
zend_throw_exception_ex(reflection_exception_ptr, 0 TSRMLS_CC, "Cannot determine default value for internal functions");
2550-
return;
2551-
}
2552-
if (param->offset < param->required) {
2553-
zend_throw_exception_ex(reflection_exception_ptr, 0 TSRMLS_CC, "Parameter is not optional");
2554-
return;
2555-
}
2556-
precv = _get_recv_op((zend_op_array*)param->fptr, param->offset);
2557-
if (!precv || precv->opcode != ZEND_RECV_INIT || precv->op2_type == IS_UNUSED) {
2558-
zend_throw_exception_ex(reflection_exception_ptr, 0 TSRMLS_CC, "Internal error");
2592+
if(!(param && precv)) {
25592593
return;
25602594
}
25612595

@@ -2568,6 +2602,34 @@ ZEND_METHOD(reflection_parameter, getDefaultValue)
25682602
}
25692603
/* }}} */
25702604

2605+
/* {{{ proto public bool ReflectionParameter::isDefaultValueConstant()
2606+
Returns whether the default value of this parameter is constant */
2607+
ZEND_METHOD(reflection_parameter, isDefaultValueConstant)
2608+
{
2609+
zend_op *precv = _reflection_param_get_default_precv(INTERNAL_FUNCTION_PARAM_PASSTHRU);
2610+
2611+
if (precv && (Z_TYPE_P(precv->op2.zv) & IS_CONSTANT_TYPE_MASK) == IS_CONSTANT) {
2612+
RETURN_TRUE;
2613+
}
2614+
2615+
RETURN_FALSE;
2616+
}
2617+
/* }}} */
2618+
2619+
/* {{{ proto public mixed ReflectionParameter::getDefaultValueConstantName()
2620+
Returns the default value's constant name if default value is constant or false */
2621+
ZEND_METHOD(reflection_parameter, getDefaultValueConstantName)
2622+
{
2623+
zend_op *precv = _reflection_param_get_default_precv(INTERNAL_FUNCTION_PARAM_PASSTHRU);
2624+
2625+
if (precv && (Z_TYPE_P(precv->op2.zv) & IS_CONSTANT_TYPE_MASK) == IS_CONSTANT) {
2626+
RETURN_STRING(Z_STRVAL_P(precv->op2.zv), 1);
2627+
}
2628+
2629+
RETURN_FALSE;
2630+
}
2631+
/* }}} */
2632+
25712633
/* {{{ proto public static mixed ReflectionMethod::export(mixed class, string name [, bool return]) throws ReflectionException
25722634
Exports a reflection object. Returns the output if TRUE is specified for return, printing it otherwise. */
25732635
ZEND_METHOD(reflection_method, export)
@@ -5903,6 +5965,8 @@ static const zend_function_entry reflection_parameter_functions[] = {
59035965
ZEND_ME(reflection_parameter, isOptional, arginfo_reflection__void, 0)
59045966
ZEND_ME(reflection_parameter, isDefaultValueAvailable, arginfo_reflection__void, 0)
59055967
ZEND_ME(reflection_parameter, getDefaultValue, arginfo_reflection__void, 0)
5968+
ZEND_ME(reflection_parameter, isDefaultValueConstant, arginfo_reflection__void, 0)
5969+
ZEND_ME(reflection_parameter, getDefaultValueConstantName, arginfo_reflection__void, 0)
59065970
PHP_FE_END
59075971
};
59085972

‎ext/reflection/tests/ReflectionParameter_DefaultValueConstant_basic1.phpt

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
--TEST--
2+
ReflectionParameter::isDefaultValueConstant() && getDefaultValueConstantName()
3+
--FILE--
4+
<?php
5+
6+
define("CONST_TEST_1", "const1");
7+
8+
function ReflectionParameterTest($test1=array(), $test2 = CONST_TEST_1) {
9+
echo $test;
10+
}
11+
$reflect = new ReflectionFunction('ReflectionParameterTest');
12+
foreach($reflect->getParameters() as $param) {
13+
if($param->getName() == 'test1') {
14+
var_dump($param->isDefaultValueConstant());
15+
}
16+
if($param->getName() == 'test2') {
17+
var_dump($param->isDefaultValueConstant());
18+
}
19+
if($param->isDefaultValueAvailable() && $param->isDefaultValueConstant()) {
20+
var_dump($param->getDefaultValueConstantName());
21+
}
22+
}
23+
24+
class Foo2 {
25+
const bar = 'Foo2::bar';
26+
}
27+
28+
class Foo {
29+
const bar = 'Foo::bar';
30+
31+
public function baz($param1 = self::bar, $param2=Foo2::bar, $param3=CONST_TEST_1) {
32+
}
33+
}
34+
35+
$method = new ReflectionMethod('Foo', 'baz');
36+
$params = $method->getParameters();
37+
38+
foreach ($params as $param) {
39+
if ($param->isDefaultValueConstant()) {
40+
var_dump($param->getDefaultValueConstantName());
41+
}
42+
}
43+
?>
44+
==DONE==
45+
--EXPECT--
46+
bool(false)
47+
bool(true)
48+
string(12) "CONST_TEST_1"
49+
string(9) "self::bar"
50+
string(9) "Foo2::bar"
51+
string(12) "CONST_TEST_1"
52+
==DONE==

‎ext/reflection/tests/ReflectionParameter_DefaultValueConstant_basic2.phpt

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
--TEST--
2+
ReflectionParameter::isDefaultValueConstant() && getDefaultValueConstantName() for namespace
3+
--FILE--
4+
<?php
5+
6+
namespace ReflectionTestNamespace {
7+
CONST TEST_CONST_1 = "Test Const 1";
8+
9+
class TestClass {
10+
const TEST_CONST_2 = "Test Const 2 in class";
11+
}
12+
}
13+
14+
namespace {
15+
function ReflectionParameterTest($test=ReflectionTestNamespace\TestClass::TEST_CONST_2, $test2 = ReflectionTestNamespace\CONST_TEST_1) {
16+
echo $test;
17+
}
18+
$reflect = new ReflectionFunction('ReflectionParameterTest');
19+
foreach($reflect->getParameters() as $param) {
20+
if($param->isDefaultValueAvailable() && $param->isDefaultValueConstant()) {
21+
echo $param->getDefaultValueConstantName() . "\n";
22+
}
23+
}
24+
echo "==DONE==";
25+
}
26+
?>
27+
--EXPECT--
28+
ReflectionTestNamespace\TestClass::TEST_CONST_2
29+
ReflectionTestNamespace\CONST_TEST_1
30+
==DONE==

‎ext/reflection/tests/ReflectionParameter_DefaultValueConstant_error.phpt

+25
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
--TEST--
2+
ReflectionParameter::getDefaultValueConstant() should raise exception on non optional parameter
3+
--FILE--
4+
<?php
5+
6+
define("CONST_TEST_1", "const1");
7+
8+
function ReflectionParameterTest($test, $test2 = CONST_TEST_1) {
9+
echo $test;
10+
}
11+
$reflect = new ReflectionFunction('ReflectionParameterTest');
12+
foreach($reflect->getParameters() as $param) {
13+
try {
14+
echo $param->getDefaultValueConstantName() . "\n";
15+
}
16+
catch(ReflectionException $e) {
17+
echo $e->getMessage() . "\n";
18+
}
19+
}
20+
?>
21+
==DONE==
22+
--EXPECT--
23+
Parameter is not optional
24+
CONST_TEST_1
25+
==DONE==

0 commit comments

Comments
 (0)