Add support for wildcards in the middle and beginning of const type annotations #658
Conversation
Seldaek
force-pushed
the
const_wildcards
branch
2 times, most recently
from
16f8dde
to
0856f4c
Compare
| if (Strings::endsWith($constantName, '*')) { | ||
| $constantNameStartsWith = Strings::substring($constantName, 0, Strings::length($constantName) - 1); | ||
| if (Strings::contains($constantName, '*')) { | ||
| $pattern = '{^' . str_replace('\\*', '.*?', preg_quote($constantName)) . '$}D'; |
There was a problem hiding this comment.
Calling https://www.php.net/manual/en/function.fnmatch.php might be an easier way to do this?
There was a problem hiding this comment.
Not so sure.. Because that also matches [] blocks etc, might do more than we want it to, although I guess the lexer won't ever give you those characters in the constant name. This preg way is easy and works, but if you really want I can do it with fnmatch.
There was a problem hiding this comment.
Yeah, this is fine if it works, but I have to admit I'm not a regex expert so I have no idea what's going on in the current code :)
There was a problem hiding this comment.
Added a comment if it helps ;) And more tests to check multiple *s.
Just to explain in more details what this does:
- preg_quote escapes all regex metacharacters, so matching $candidate against
'{^' . preg_quote($constantName) . '$}D'would simply be equivalent to doing$constantName === $candidate - That's not so helpful of course so adding the str_replace turns back
\*(i.e. escaped wildcards into.*?so you end up with a pattern likeFOO*=>FOO.*?which allows for anything where the wildcard was - The complete pattern is{^FOO.*?$}Dthough to make sure it does not match a part of the string, the anchors ^/$ make sure it's matching the whole candidate name. - The
Dmodifier ensures that$cannot match if there is a newline, without it^FOO.*?$would match alsoFOOBAR\nwhich we don't want even though here I guess it is not possible to get such a string to be matched against anyway.
Seldaek
force-pushed
the
const_wildcards
branch
from
0856f4c
to
0525467
Compare
ondrejmirtes
force-pushed
the
const_wildcards
branch
from
0525467
to
0197c3a
Compare
| if (Strings::endsWith($constantName, '*')) { | ||
| $constantNameStartsWith = Strings::substring($constantName, 0, Strings::length($constantName) - 1); | ||
| if (Strings::contains($constantName, '*')) { | ||
| $pattern = '{^' . str_replace('\\*', '.*?', preg_quote($constantName)) . '$}D'; |
|
Force-pushed the phpdoc-parser update here, I'm gonna wait for the build and merge it. Thank you, I appreciate it, it was a pleasure! You get how open-source works (which isn't surprising from you :)) |
Fixes phpstan/phpstan#5534
Depends on phpstan/phpdoc-parser#81 (hence the build failures)