ObjectRepository::findBy orderBy should accept SortDirection

[dmitryuk]

Feature Request

What

\Doctrine\Persistence\ObjectRepository::findBy
php doc for $orderBy argument should accept array<\SortDirection> enum

Why

Since php 8.6 (and symfony/polyfill-php86) provide \SortDirection enum

How

Fix phpdoc for \Doctrine\Persistence\ObjectRepository::findBy

Relates doctrine/orm#11313

[greg0ire]

On v4, it should accept it, and on v5, it must accept it, and no longer needs to accept strings. Requiring that every implementation suddenly accept it would be a breaking change. Not sure what to do on 4.x. @derrabus @SenseException @stof @GromNaN thoughts? Maybe an @method annotation would help on 4.x? Also, requiring a polyfill just for a phpdoc comment feels weird.

[GromNaN]

Thanks @dmitryuk for reporting this issue. The new enum will be added in 5.0.0 by #525.

[dmitryuk]

What about v4?

[GromNaN]

See #524 (comment)

Widening parameter type is a BC break for implementers (as implementers are not allowed to use a more restrictive type based on the Liskov Substitution Principle).

[GromNaN]

Two PRs were opened to allow SortDirection values wherever sort directions are accepted:

• Allow SortDirection in EntityRepository::findBy() and findOneBy() orm#12613: EntityRepository::findBy() and findOneBy() now accept and document SortDirection, while strings remain non-deprecated, since the ObjectRepository interface of persistence 3.x and 4.x still documents strings as the only statically valid values.
• Add SortDirection support to query and aggregation sort orders mongodb-odm#3048: applies SortDirection to the document repository findBy()/findOneBy() and to the query builder, expression and aggregation sort orders.