Skip to content

PhpToken::is(): switch @param to typehint #16218

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

PhpToken::is(): switch @param to typehint #16218

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions ext/tokenizer/tokenizer.stub.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,7 @@ public static function tokenize(string $code, int $flags = 0): array {}

final public function __construct(int $id, string $text, int $line = -1, int $pos = -1) {}

/** @param int|string|array $kind */
public function is($kind): bool {}
public function is(int|string|array $kind): bool {}
Copy link
Member

@kocsismate kocsismate Oct 4, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In order to be able to add the type declaration, the custom parameter parsing should be consistent with the "real" ZPP if it contained Z_PARAM_LONG() which ultimately runs the zend_parse_arg_long_weak function for type juggling.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm sorry, I don't really understand what you're saying - is the typehint not allowed because integer-like strings are not cast to integers?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So what I really wanted to say is that ideally, a native type declaration should only be added when ZPP behaves exactly how the same type declaration would be treated in userland. However, the validation in debug mode only checks whether the function doesn't throw when in fact it should based on the type declaration: https://github.com/php/php-src/blob/0b3684c48e8dd1b960bd179f7957d69d0b882ea2/Zend/zend_vm_execute.h#L2043

PhpToken::is() always parses parameters strictly, so it rather throws when it shouldn't (e.g. when a float or a numeric string is passed to it), so it slightly differs from what a userland int|string|array type check would do. That's why in the past we changed a lot of Z_PARAM_ZVAL() calls to more precise Z_PARAM_* calls, but I just cannot remember whether it was strictly necessary to do, or if we just did it because it was better for consistency (since the zend_internal_call_arginfo_violation check doesn't always find the issue). @Girgias could you please refresh my mind? Do you think PhpToken::is() can have the native type declaration?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Huuuum, we have been using native types for GMP functions, but it does handle the deprecations for null and weak type semantics.

I know we don't use native types explicitly for method_exists and property_exists so that we can by-pass known wrong values of int and bool. (and maybe we should revisit this for those cases.)

So I think you are correct @kocsismate in that we don't do it for consistency with weak mode.


public function isIgnorable(): bool {}

Expand Down
4 changes: 2 additions & 2 deletions ext/tokenizer/tokenizer_arginfo.h
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading