Add ReflectionFunctionAbstract::getParameter() and hasParameter() #10431

ollieread · 2023-01-24T11:10:04Z

This PR is a work in progress, but it adds hasParameter() and getParameter() to ReflectionFunctionAbstract.

Both methods accept int|string $parameter to retrieve/check parameters by position or name. hasParameter returns true or false, whereas getParameter returns ReflectionParameter or throws an exception.

Addresses #10341

nielsdos · 2023-01-24T16:29:51Z

The reason you can't call your newly added functions from php scripts yet is becausr you need to update the stubs. In particular you need to add your method declarations to php_reflection.stub.php iirc, and then run build/gen_stub.php or run make.

nielsdos

Thanks for your work on this feature, I think it generally makes sense, just some comments on some details :)

ext/reflection/php_reflection.c

ext/reflection/tests/ReflectionFunction_hasParameter.phpt

ext/reflection/tests/ReflectionMethod_hasParameter.phpt

ext/reflection/php_reflection.c

Girgias

Please use the Z_PARAM_STR_OR_LONG() ZPP function. For examples of usage look at ZEND_METHOD(ReflectionParameter, __construct) in the same file.

ollieread · 2023-07-25T07:37:10Z

Sorry all, a lot has been going on. What's the best way to pick this back up? I know we are approaching an 8.3 release, so I should target that, or is 8.2 still fine?

Girgias · 2023-07-25T09:19:52Z

Sorry all, a lot has been going on. What's the best way to pick this back up? I know we are approaching an 8.3 release, so I should target that, or is 8.2 still fine?

Should be rebased on master for 8.3 release

ollieread · 2023-07-25T10:45:15Z

Please use the Z_PARAM_STR_OR_LONG() ZPP function. For examples of usage look at ZEND_METHOD(ReflectionParameter, __construct) in the same file.

I've used ReflectionParameter::__construct as an example to completely refactor these methods, and assuming that I have understood correctly, all previous points should be addressed by the changes.

ollieread · 2023-07-25T11:18:45Z

I'm unable to run make locally, as I keep getting the following error:

make: *** No rule to make target ext/standard/hrtime.h', needed by ext/standard/basic_functions.lo'.

Girgias · 2023-07-25T14:05:17Z

I'm unable to run make locally, as I keep getting the following error:

make: *** No rule to make target ext/standard/hrtime.h', needed by ext/standard/basic_functions.lo'.

You need to do a complete recompile, which entails make distclean, ./buildcoonf, ./configure and then make

ollieread · 2023-07-25T14:06:50Z

I'm unable to run make locally, as I keep getting the following error:

make: *** No rule to make target ext/standard/hrtime.h', needed by ext/standard/basic_functions.lo'.

You need to do a complete recompile, which entails make distclean, ./buildcoonf, ./configure and then make

Excellent, thank you. Sorry, I'll try and write them down this time 😅

nielsdos · 2023-07-25T15:29:08Z

You also have to add your new functions to the stub file php_reflection.stub.php, such that PHP can find it and is aware of how your function signature looks.

ollieread · 2023-07-25T16:04:50Z

Will add tests for ReflectionMethod, just running some errands first.

Girgias

Very quick review with some immediate comments

ext/reflection/php_reflection.c

ext/reflection/tests/ReflectionFunction_getParameter_basic.phpt

ext/reflection/tests/ReflectionFunction_getParameter_error1.phpt

ext/reflection/tests/ReflectionFunction_hasParameter.phpt

ext/reflection/tests/ReflectionMethod_getParameter_error1.phpt

ext/reflection/php_reflection.c

ollieread · 2023-12-13T12:47:32Z

I'm so sorry about leaving this, had eviction, moving and family issues. Should hopefully pick this back up either today after my kids' nativity play, or tomorrow.

Thank you for your patience and not closing the PR.

Girgias · 2023-12-15T01:19:28Z

No worries, life happens :)

…er()

…arameter()

ext/reflection/php_reflection.c

This reverts commit 99ea19c.

…r a function/method that doesn't exist

ext/reflection/php_reflection.c

ollieread · 2024-01-25T12:54:05Z

Both of the debug jobs are failing on the tests I just updated, and the release one is failing because of a separate test (not one of mine). I've actually had a similar problem with another PR #13224, where jobs are failing on the debug builds, I've no idea why that would happen.

Girgias · 2024-01-25T13:07:38Z

Both of the debug jobs are failing on the tests I just updated, and the release one is failing because of a separate test (not one of mine). I've actually had a similar problem with another PR #13224, where jobs are failing on the debug builds, I've no idea why that would happen.

You are leaking memory I would recommend that you build your debug build with UBSAN and ASAN as this will catch a lot of errors :)

ext/reflection/php_reflection.c

Girgias

Looks fine to me other than the position thing.

ext/reflection/php_reflection.c

ext/reflection/php_reflection.stub.php

ext/reflection/php_reflection.c

ollieread · 2024-02-01T20:24:29Z

All updated, but I am having issues with the format for the exception, as %lld doesn't work for zend_long on the LINUX platforms. I've had a look through the rest of the codebase, and I've not noticed a way to do it, so I'm probably missing it.

kocsismate · 2024-02-01T20:34:31Z

I've had a look through the rest of the codebase, and I've not noticed a way to do it, so I'm probably missing it.

You can use the ZEND_LONG_FMT macro. :) An example: "Undefined array key " ZEND_LONG_FMT But there are plenty others of them.

ollieread · 2024-02-01T20:37:16Z

I've had a look through the rest of the codebase, and I've not noticed a way to do it, so I'm probably missing it.

You can use the ZEND_LONG_FMT macro. :) An example: "Undefined array key " ZEND_LONG_FMT But there are plenty others of them.

Thank you! I did see that and wonder, but I'm still very new to C itself, let alone this codebase!

ollieread · 2024-02-02T10:57:14Z

All done and working now, the MacOS failed test is unrelated.

# Conflicts: # ext/reflection/php_reflection_arginfo.h

kocsismate · 2024-02-05T21:25:22Z

The failures after the merge are because the arginfo file is not up-to-date. Please regenerate it.

ext/reflection/php_reflection.c

kocsismate · 2024-02-05T21:39:21Z

ext/reflection/php_reflection.c

+    }
+
+    if (arg_name != NULL) {
+        if (ZSTR_LEN(arg_name) == 0) {


Besides an empty string, additional null bytes should also checked the following way:

if (CHECK_NULL_PATH(source, source_len)) { zend_argument_value_error(1, "must not contain any null bytes"); return NULL; }

(code is copy pasted from ext/dom, but there are plenty of other examples as well)

kocsismate · 2024-02-05T21:43:20Z

ext/reflection/php_reflection.c

+            RETURN_THROWS();
+        }
+    } else {
+        if (position < 0) {


Wait, do these functions use zero index for parameters? I think it's not a good idea, since error messages use a 1-index (Argument #1 ...)

I know that getParameters() returns a zero-index array, so it's not exactly clear which indexing is the most expected for people. For me, it's the 1-based one. 🤔

Yeah we had this discussion earlier. It might make sense to send an email to internals, but I also think using 1-indexed here is better.

Yeah, if we change that here @kocsismate we would probably want to change the return value of getPosition(), which I would imagine is going to break a lot of stuff.

My opinion is that we should use zero index to be consistent with getPosition and the parameter array.
I read "Argument #1 ..." in my head as "argument number 1", not "argument index 1".
Anyway, this needs discussion on the ML as said before.

My opinion is that we should use zero index to be consistent with getPosition and the parameter array. I read "Argument #1 ..." in my head as "argument number 1", not "argument index 1". Anyway, this needs discussion on the ML as said before.

I agree, as we're used to dealing with 0-index arrays.

Shall I just continue as is for now, and then send something to the ML? What specifically should I be mentioning? This PR and the whole discussion over index vs position?

I would prefer a discussion on the ML before anything is done here.

And the discussion should be, here are two new helper methods which take either the name of a parameter or its position. However there is contention between should this be 1 indexed or 0 indexed due to the existing API.

I would prefer a discussion on the ML before anything is done here.

And the discussion should be, here are two new helper methods which take either the name of a parameter or its position. However there is contention between should this be 1 indexed or 0 indexed due to the existing API.

Have started one on there @Girgias, sorry about the delay.

https://externals.io/message/123251

kocsismate · 2024-02-05T21:45:32Z

ext/reflection/php_reflection.c

+    }
+
+    if (arg_name != NULL) {
+        if (ZSTR_LEN(arg_name) == 0) {


the null byte check should also be done here as well

github-actions bot added the Extension: reflection label Jan 24, 2023

nielsdos reviewed Jan 24, 2023

View reviewed changes

kocsismate reviewed Jan 24, 2023

View reviewed changes

ext/reflection/php_reflection.c Outdated Show resolved Hide resolved

ext/reflection/php_reflection.c Outdated Show resolved Hide resolved

ext/reflection/php_reflection.c Outdated Show resolved Hide resolved

Girgias requested changes Jan 24, 2023

View reviewed changes

iluuu1994 mentioned this pull request Mar 28, 2023

Adding hasParameter() and getParameter() methods to ReflectionFunctionAbstract #10341

Closed

ollieread requested a review from Girgias July 25, 2023 18:09

Girgias requested changes Jul 26, 2023

View reviewed changes

ollieread requested a review from Girgias August 7, 2023 10:28

Girgias reviewed Aug 7, 2023

View reviewed changes

ext/reflection/php_reflection.c Show resolved Hide resolved

ext/reflection/php_reflection.c Outdated Show resolved Hide resolved

ext/reflection/php_reflection.c Outdated Show resolved Hide resolved

ext/reflection/php_reflection.c Outdated Show resolved Hide resolved

Girgias requested a review from iluuu1994 August 7, 2023 14:38

ollieread mentioned this pull request Jan 22, 2024

Add additional methods for reflections that have attributes #8489

Open

ollieread added 8 commits January 22, 2024 19:38

Add ReflectionFunctionAbstract::getParameter() and hasParameter()

87f8884

Refactor based on suggestions to avoid custom code

44c8db9

Add missing exceptions from hasParameter tests

618cd84

Fix bugs in ReflectionFunctionAbstract::hasParameter() and getParamet…

c921efd

…er()

Update equals check for parameter name

88392c0

Removed unused variable

479bec6

Remove incrementing of arg_info

4d9cead

Change parameter name handling to account for internal arg_info

ba2a03d

ollieread added 2 commits January 23, 2024 13:31

Throw an error if an empty string is passed to getParamater() or hasP…

2984667

…arameter()

Fix issue with empty string check and fix tests

99ea19c

Girgias reviewed Jan 23, 2024

View reviewed changes

ext/reflection/php_reflection.c Outdated Show resolved Hide resolved

ollieread added 3 commits January 23, 2024 20:10

Revert "Fix issue with empty string check and fix tests"

28bbb66

This reverts commit 99ea19c.

Refixed issue with checking for empty strings

e9309a1

Actually throw an exception when attempting to retrieve parameters fo…

23aac25

…r a function/method that doesn't exist

ollieread requested a review from Girgias January 24, 2024 09:45

Girgias reviewed Jan 24, 2024

View reviewed changes

ext/reflection/php_reflection.c Outdated Show resolved Hide resolved

Made error message when there are no parameters more specific

47bbe4b

Girgias reviewed Jan 25, 2024

View reviewed changes

ext/reflection/php_reflection.c Outdated Show resolved Hide resolved

Add macro for throwing formatted exception messages

ddb9e30

ollieread requested a review from Girgias January 26, 2024 17:52

Girgias reviewed Jan 27, 2024

View reviewed changes

ext/reflection/php_reflection.c Outdated Show resolved Hide resolved

kocsismate reviewed Feb 1, 2024

View reviewed changes

ext/reflection/php_reflection.stub.php Outdated Show resolved Hide resolved

kocsismate reviewed Feb 1, 2024

View reviewed changes

ext/reflection/php_reflection.c Outdated Show resolved Hide resolved

ollieread added 3 commits February 1, 2024 19:29

Change parameter name to param to be consistent

01aa789

Changed error messages to be more helpful

0a2f4e3

Change exception message for empty strings

627c9f8

Use correct format for zend_long type

da0a602

Merge branch 'master' into reflectionfunction-getparameter

8d389b9

Merge branch 'master' into reflectionfunction-getparameter

ceda3c1

# Conflicts: # ext/reflection/php_reflection_arginfo.h

kocsismate reviewed Feb 5, 2024

View reviewed changes

ext/reflection/php_reflection.c Show resolved Hide resolved

kocsismate reviewed Feb 5, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add ReflectionFunctionAbstract::getParameter() and hasParameter() #10431

Add ReflectionFunctionAbstract::getParameter() and hasParameter() #10431

ollieread commented Jan 24, 2023

nielsdos commented Jan 24, 2023

nielsdos left a comment

Girgias left a comment

ollieread commented Jul 25, 2023

Girgias commented Jul 25, 2023

ollieread commented Jul 25, 2023

ollieread commented Jul 25, 2023

Girgias commented Jul 25, 2023

ollieread commented Jul 25, 2023

nielsdos commented Jul 25, 2023

ollieread commented Jul 25, 2023

Girgias left a comment

ollieread commented Dec 13, 2023

Girgias commented Dec 15, 2023

ollieread commented Jan 25, 2024 •

edited

Loading

Girgias commented Jan 25, 2024

Girgias left a comment

ollieread commented Feb 1, 2024 •

edited

Loading

kocsismate commented Feb 1, 2024 •

edited

Loading

ollieread commented Feb 1, 2024

ollieread commented Feb 2, 2024

kocsismate commented Feb 5, 2024

kocsismate Feb 5, 2024

kocsismate Feb 5, 2024

kocsismate Feb 5, 2024

Girgias Feb 6, 2024

ollieread Feb 6, 2024

nielsdos Feb 6, 2024

ollieread Feb 7, 2024

Girgias Feb 7, 2024

ollieread May 2, 2024

kocsismate Feb 5, 2024

Add ReflectionFunctionAbstract::getParameter() and hasParameter() #10431

Are you sure you want to change the base?

Add ReflectionFunctionAbstract::getParameter() and hasParameter() #10431

Conversation

ollieread commented Jan 24, 2023

nielsdos commented Jan 24, 2023

nielsdos left a comment

Choose a reason for hiding this comment

Girgias left a comment

Choose a reason for hiding this comment

ollieread commented Jul 25, 2023

Girgias commented Jul 25, 2023

ollieread commented Jul 25, 2023

ollieread commented Jul 25, 2023

Girgias commented Jul 25, 2023

ollieread commented Jul 25, 2023

nielsdos commented Jul 25, 2023

ollieread commented Jul 25, 2023

Girgias left a comment

Choose a reason for hiding this comment

ollieread commented Dec 13, 2023

Girgias commented Dec 15, 2023

ollieread commented Jan 25, 2024 • edited Loading

Girgias commented Jan 25, 2024

Girgias left a comment

Choose a reason for hiding this comment

ollieread commented Feb 1, 2024 • edited Loading

kocsismate commented Feb 1, 2024 • edited Loading

ollieread commented Feb 1, 2024

ollieread commented Feb 2, 2024

kocsismate commented Feb 5, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ollieread commented Jan 25, 2024 •

edited

Loading

ollieread commented Feb 1, 2024 •

edited

Loading

kocsismate commented Feb 1, 2024 •

edited

Loading