Add ReflectionFunctionAbstract::getParameter() and hasParameter()

ext/reflection/php_reflection.c

@@ -102,6 +102,9 @@ PHPAPI zend_class_entry *reflection_fiber_ptr;
 #define _DO_THROW(msg) \
 	zend_throw_exception(reflection_exception_ptr, msg, 0);
 
+#define _DO_THROW_EX(msg, ...) \
+    zend_throw_exception_ex(reflection_exception_ptr, 0, msg, __VA_ARGS__);
+
 #define GET_REFLECTION_OBJECT() do { \
 	intern = Z_REFLECTION_P(ZEND_THIS); \
 	if (intern->ptr == NULL) { \
@@ -1520,6 +1523,28 @@ static int get_parameter_default(zval *result, parameter_reference *param) {
 	}
 }
 
+static zend_long get_parameter_position(zend_function *func, zend_string* arg_name, uint32_t num_args) {
+    struct _zend_arg_info *arg_info = func->common.arg_info;
+    uint32_t i;
+    bool internal = has_internal_arg_info(func);
+
+    for (i = 0; i < num_args; i++) {
+        if (arg_info[i].name) {
+            if (internal) {
+                if (strcmp(((zend_internal_arg_info*)arg_info)[i].name, ZSTR_VAL(arg_name)) == 0) {
+                    return i;
+                }
+            } else {
+                if (zend_string_equals(arg_name, arg_info[i].name)) {
+                    return i;
+                }
+            }
+        }
+    }
+
+    return -1;
+}
+
 /* {{{ Preventing __clone from being called */
 ZEND_METHOD(ReflectionClass, __clone)
 {
@@ -2106,7 +2131,136 @@ ZEND_METHOD(ReflectionFunctionAbstract, getNumberOfRequiredParameters)
 }
 /* }}} */
 
-/* {{{ Returns an array of parameter objects for this function */
+/* {{{ Returns whether a parameter exists or not */
+ZEND_METHOD(ReflectionFunctionAbstract, hasParameter)
+{
+    reflection_object *intern;
+    zend_function *fptr;
+    zend_string *arg_name = NULL;
+    zend_long position;
+    uint32_t num_args;
+
+    ZEND_PARSE_PARAMETERS_START(1, 1)
+        Z_PARAM_STR_OR_LONG(arg_name, position)
+    ZEND_PARSE_PARAMETERS_END();
+
+    GET_REFLECTION_OBJECT_PTR(fptr);
+
+    num_args = fptr->common.num_args;
+
+    if (fptr->common.fn_flags & ZEND_ACC_VARIADIC) {
+        num_args++;
+    }
+
+    if (!num_args) {
+        RETURN_FALSE;
+    }
+
+    if (arg_name != NULL) {
+        if (ZSTR_LEN(arg_name) == 0) {
+            zend_argument_value_error(1, "must not be empty");
+            RETURN_THROWS();
+        }
+
+        if (get_parameter_position(fptr, arg_name, num_args) > -1) {
+            RETURN_TRUE;
+        }
+
+        RETURN_FALSE;
+    } else {
+        if (position < 0) {
+            zend_argument_value_error(1, "must be greater than or equal to 0");
+            RETURN_THROWS();
+        }
+
+        RETURN_BOOL(position < num_args);
+    }
+}
+/* }}} */
+
+/* {{{ Returns a parameter specified by its name */
+ZEND_METHOD(ReflectionFunctionAbstract, getParameter)
+{
+    reflection_object *intern;
+    zend_function *fptr;
+    zend_string *arg_name = NULL;
+    zend_long position;
+    struct _zend_arg_info *arg_info;
+    uint32_t num_args;
+    zval reflection;
+
+    ZEND_PARSE_PARAMETERS_START(1, 1)
+        Z_PARAM_STR_OR_LONG(arg_name, position)
+    ZEND_PARSE_PARAMETERS_END();
+
+    GET_REFLECTION_OBJECT_PTR(fptr);
+
+    num_args = fptr->common.num_args;
+    arg_info = fptr->common.arg_info;
+
+    if (fptr->common.fn_flags & ZEND_ACC_VARIADIC) {
+        num_args++;
+    }
+
+    if (num_args < 1) {
+        if (fptr->common.scope) {
+            _DO_THROW_EX("Method %s::%s() has no parameters", ZSTR_VAL(fptr->common.scope->name), ZSTR_VAL(fptr->common.function_name));
+        } else {
+            _DO_THROW_EX("Function %s() has no parameters", ZSTR_VAL(fptr->common.function_name));
+        }
+
+        RETURN_THROWS();
+    }
+
+    if (arg_name != NULL) {
+        if (ZSTR_LEN(arg_name) == 0) {
+            zend_argument_value_error(1, "must not be empty");
+            RETURN_THROWS();
+        }
+
+        position = get_parameter_position(fptr, arg_name, num_args);
+
+        if (position == -1) {
+            if (fptr->common.scope) {
+                _DO_THROW_EX("Method %s::%s() has no parameter named \"%s\"",
+                             ZSTR_VAL(fptr->common.scope->name), ZSTR_VAL(fptr->common.function_name), ZSTR_VAL(arg_name));
+            } else {
+                _DO_THROW_EX("Function %s() has no parameter named \"%s\"",
+                             ZSTR_VAL(fptr->common.function_name), ZSTR_VAL(arg_name));
+            }
+            RETURN_THROWS();
+        }
+    } else {
+        if (position < 0) {
+            zend_argument_value_error(1, "must be greater than or equal to 0");
+            RETURN_THROWS();
+        }
+        if (position >= num_args) {
+            if (fptr->common.scope) {
+                _DO_THROW_EX("Method %s::%s() has no parameter at offset " ZEND_LONG_FMT,
+                             ZSTR_VAL(fptr->common.scope->name), ZSTR_VAL(fptr->common.function_name), position);
+            } else {
+                _DO_THROW_EX("Function %s() has no parameter at offset " ZEND_LONG_FMT,
+                             ZSTR_VAL(fptr->common.function_name), position);
+            }
+            RETURN_THROWS();
+        }
+    }
+
+    reflection_parameter_factory(
+        _copy_function(fptr),
+        Z_ISUNDEF(intern->obj) ? NULL : &intern->obj,
+        &arg_info[position],
+        position,
+        position < fptr->common.required_num_args,
+        &reflection
+    );
+
+    RETURN_OBJ(Z_OBJ(reflection));
+}
+/* }}} */
+
+/* {{{ Returns the function/method specified by its name */
 ZEND_METHOD(ReflectionFunctionAbstract, getParameters)
 {
 	reflection_object *intern;

ext/reflection/php_reflection.stub.php

@@ -112,6 +112,10 @@ public function hasTentativeReturnType(): bool {}
     public function getTentativeReturnType(): ?ReflectionType {}
 
     public function getAttributes(?string $name = null, int $flags = 0): array {}
+
+    public function hasParameter(int|string $param): bool;
+
+    public function getParameter(int|string $param): ReflectionParameter;
 }
 
 class ReflectionFunction extends ReflectionFunctionAbstract

ext/reflection/tests/ReflectionFunction_getParameter_basic.phpt

@@ -0,0 +1,41 @@
+--TEST--
+ReflectionFunction::getParameter()
+--FILE--
+<?php
+function foo(string $bar) {}
+
+$function = new ReflectionFunction('sort');
+var_dump($function->getParameter('array'));
+var_dump($function->getParameter('flags'));
+var_dump($function->getParameter(0));
+var_dump($function->getParameter(1));
+
+$function = new ReflectionFunction('foo');
+var_dump($function->getParameter('bar'));
+var_dump($function->getParameter(0));
+?>
+--EXPECT--
+object(ReflectionParameter)#2 (1) {
+  ["name"]=>
+  string(5) "array"
+}
+object(ReflectionParameter)#2 (1) {
+  ["name"]=>
+  string(5) "flags"
+}
+object(ReflectionParameter)#2 (1) {
+  ["name"]=>
+  string(5) "array"
+}
+object(ReflectionParameter)#2 (1) {
+  ["name"]=>
+  string(5) "flags"
+}
+object(ReflectionParameter)#1 (1) {
+  ["name"]=>
+  string(3) "bar"
+}
+object(ReflectionParameter)#1 (1) {
+  ["name"]=>
+  string(3) "bar"
+}

ext/reflection/tests/ReflectionFunction_getParameter_error.phpt

@@ -0,0 +1,63 @@
+--TEST--
+ReflectionFunction::getParameter() errors
+--FILE--
+<?php
+$function = new ReflectionFunction('sort');
+function foo(string $bar) {}
+function noParams() {}
+
+try {
+    var_dump($function->getParameter('Array'));
+} catch(ReflectionException $e) {
+    print($e->getMessage() . PHP_EOL);
+}
+
+try {
+    var_dump($function->getParameter(-1));
+} catch(ValueError $e) {
+    print($e->getMessage() . PHP_EOL);
+}
+
+try {
+    var_dump($function->getParameter(3));
+} catch(ReflectionException $e) {
+    print($e->getMessage() . PHP_EOL);
+}
+
+$function = new ReflectionFunction('foo');
+
+try {
+    var_dump($function->getParameter('Bar'));
+} catch(ReflectionException $e) {
+    print($e->getMessage() . PHP_EOL);
+}
+
+try {
+    var_dump($function->getParameter(-1));
+} catch(ValueError $e) {
+    print($e->getMessage() . PHP_EOL);
+}
+
+try {
+    var_dump($function->getParameter(1));
+} catch(ReflectionException $e) {
+    print($e->getMessage() . PHP_EOL);
+}
+
+$function = new ReflectionFunction('noParams');
+
+try {
+    var_dump($function->getParameter(1));
+} catch(ReflectionException $e) {
+    print($e->getMessage() . PHP_EOL);
+}
+
+?>
+--EXPECT--
+Function sort() has no parameter named "Array"
+ReflectionFunctionAbstract::getParameter(): Argument #1 ($param) must be greater than or equal to 0
+Function sort() has no parameter at offset 3
+Function foo() has no parameter named "Bar"
+ReflectionFunctionAbstract::getParameter(): Argument #1 ($param) must be greater than or equal to 0
+Function foo() has no parameter at offset 1
+Function noParams() has no parameters

ext/reflection/tests/ReflectionFunction_hasParameter_basic.phpt

@@ -0,0 +1,31 @@
+--TEST--
+ReflectionFunction::hasParameter()
+--FILE--
+<?php
+function foo(string $bar) {}
+
+$function = new ReflectionFunction('sort');
+var_dump($function->hasParameter('array'));
+var_dump($function->hasParameter('Array'));
+var_dump($function->hasParameter('string'));
+var_dump($function->hasParameter(0));
+var_dump($function->hasParameter(1));
+
+$function = new ReflectionFunction('foo');
+var_dump($function->hasParameter('bar'));
+var_dump($function->hasParameter('Bar'));
+var_dump($function->hasParameter('string'));
+var_dump($function->hasParameter(0));
+var_dump($function->hasParameter(1));
+?>
+--EXPECT--
+bool(true)
+bool(false)
+bool(false)
+bool(true)
+bool(true)
+bool(true)
+bool(false)
+bool(false)
+bool(true)
+bool(false)

ext/reflection/tests/ReflectionFunction_hasParameter_error.phpt

@@ -0,0 +1,25 @@
+--TEST--
+ReflectionFunction::hasParameter() errors
+--FILE--
+<?php
+function foo(string $bar) {}
+
+$function = new ReflectionFunction('sort');
+
+try {
+    var_dump($function->hasParameter(-1));
+} catch (ValueError $e) {
+    print($e->getMessage() . PHP_EOL);
+}
+
+$function = new ReflectionFunction('foo');
+
+try {
+    var_dump($function->hasParameter(-1));
+} catch (ValueError $e) {
+    print($e->getMessage() . PHP_EOL);
+}
+?>
+--EXPECT--
+ReflectionFunctionAbstract::hasParameter(): Argument #1 ($param) must be greater than or equal to 0
+ReflectionFunctionAbstract::hasParameter(): Argument #1 ($param) must be greater than or equal to 0