PhpdocOrderByValueFixer - Add additional annotations to sort

[localheinz]

This PR

• adjusts the phpdoc_order_by_value fixer to allow sorting of additional annotations by value
  • @method
  • @property
  • @property-read
  • @property-write

[coveralls]

Coverage increased (+0.007%) to 91.375% when pulling f98de85 on localheinz:feature/phpdoc-order-by-value into bb6ee85 on FriendsOfPHP:2.17.

[SpacePossum]

Thanks for the PR!
Sounds like a good idea :)
Been testing a bit and wanted to share so thoughts.

Starting with the added @method support.
Taking an example from the test:
@method int foo(array $b)
will get the "comparableContent" fooarray $b).
Maybe it can improved to make it the function name (here foo) only?
Test:

[
    '<?php
    /**
     * @method int foo(Z $b)
     * @method int fooA( $b)
     */
    class Foo {}
    ',
    '<?php
    /**
     * @method int fooA( $b)
     * @method int foo(Z $b)
     */
    class Foo {}
    ',
],

If there is no return type, for example @method fooA( $b), the "comparableContent" becomes * @method fooa( $b).
I think here the @method part should be omitted to ensure correct sorting multiple statements, for example the test:

[
    '<?php
    /**
     * @method int a($b)
     * @method z($b)
     */
    class Foo {}
    ',
    '<?php
    /**
     * @method z($b)
     * @method int a($b)
     */
    class Foo {}
    ',
],

The properties fixing have a similar issue. For example @property-read $bar gets "comparableContent" * @property-read $bar while the type ones, for example, * @property-read int|\stdClass $foo get "comparableContent" $foo, meaning that sorting a list property-reads with and without types might not go as expected.
Test:

[
                '<?php
                /**
                 * @property-read $a
                 * @property-read int $z
                 */
                class Foo {}
                ',
                '<?php
                /**
                 * @property-read int $z
                 * @property-read $a
                 */
                class Foo {}
                ',
            ]

Of course this is me expecting the sorting is on the names of the method/properties and being agnostic to the return type, however to might not what others expect.

[localheinz]

@SpacePossum

Thank you for taking the time to review and experiment!

Will look into it!

[localheinz]

@SpacePossum

How about now?

[SpacePossum]

looking great, thanks!

[SpacePossum]

Thank you @localheinz.

[localheinz]

Thank you, @drupol and @SpacePossum!