OptionalParametersAfterRequiredRector does not change docblocks

[cweiske]

Rector\CodeQuality\Rector\ClassMethod\OptionalParametersAfterRequiredRector switched the position of two parameters in the method signature but did not modify the docblock's @param order.

This was a TYPO3 system which uses symfony's dependency injection, and this prefers docblocks over method parameters. So the DI called the method with the wrong parameter order because of the discrepancy between docblock and signature.

    /**
     * @param ?string $position Position as "lat,lon": 53.550967,9.993084
     * @param ?int    $distance Distance in meters
     */
    public function findAction(?int $distance, ?string $position = null): ResponseInterface
    {

I don't know if modifying docblocks is out of scope for rector.

[mspirkov]

It seems to me that this will significantly complicate the OptionalParametersAfterRequiredRector.
Perhaps it would be more reasonable to use this: https://github.com/PHP-CS-Fixer/PHP-CS-Fixer/blob/master/doc/rules/phpdoc/phpdoc_param_order.rst
In general, Rector can change the code style quite often, and I would suggest that you use the following tool to control it: https://github.com/easy-coding-standard/easy-coding-standard