Changed DocBlock param type invalid or not consistent

[sbuerk]

After upgrading dependencies which includes this package from 1.2.1 to 1.2.2 phpstan now complaints because of invalid types for a method call.

I have commented it directly here: 863bff4#r67532655

In the TYPO3 implementation we have a call which uses the Lexer public class constants, which are integer typed constants to check thinks, like:

$isNextToken = $lexer->isNextTokenAny([Lexer::T_INDEX, Lexer::T_KEY]);

phpstan now complains because this do not match with the changed docblock type for the param from array to string[].

Not sure, either the docblock should be changed to int[]|string[] or mixed[] to mitigate this. Not sure about the whole implemention. If token keywords should be string, the class constants should be changed too.

Example error message from phpstan:

  1177   Parameter #1 $tokens of method                                 
         Doctrine\Common\Lexer\AbstractLexer::isNextTokenAny() expects  
         array<string>, array<int, int> given.

[greg0ire]

@sbuerk why don't you send a PR? In #48, I did what I think was right but I think I know the library less than you do (I don't use it directly). Moreover, if you manually edit the phpdoc in your project, you will be able to validate that things go back to normal (no static analysis errors), or that more changes are needed.

[sbuerk]

@greg0ire Wanted to report this issue first. For the case some may/can confirm this issue or have a pr ready faster then I - had to deal with a lot of forks yesterday to takle upraising bugs because of "3rd party" changes in several projects - that was the reason why not directly adding a "pr" - which would have been a "quick shot".

Try to test this out deeper today and eventually adding a PR for this.

[greg0ire]

Great! Looking forward to it!

[greg0ire]

Regarding your remark, I'd go with list<int|string>, or even list<int>|list<string>, as I don't think another type would be very reasonable to use.

[sbuerk]

I'm currently on it. Already added a test ConcreteLexer with integer tokens, adopted from the string based token tester. However, psalm do not detect the mismatch in these changes.

I think these tests are still not useless, as it tests the integer based tokens. Our implementation was based on the documentation, and thus assuming integer based tokens are a valid implementation.

See: https://www.doctrine-project.org/projects/doctrine-lexer/en/1.2/simple-parser-example.html#simple-parser-example

We use phpstan in our project which reports this missmatch however. Will test your suggestions if phpstan will work with that and use that docblocks then instead of already proved working int[]|string[]. And union type for isNextTokenAny() is only a concequence and adoption of the isNextToken() and other methods using int|string for token types.

[greg0ire]

Released as https://github.com/doctrine/lexer/releases/tag/1.2.3