Fix 1246: configure default order on ApiResource annotation

[vincentchalamon]

Q	A
Bug fix?	no
New feature?	yes
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	#1246
License	MIT
Doc PR	api-platform/docs#235

[dunglas]

Great feature, thanks!! I just left a small comment.

[dunglas]

This a BC break, can you add it as an optional last parameter?

[Simperfit]

Could you please rebase instead of merging ?

[dunglas]

Thank you @vincentchalamon

[dunglas]

I probably have been too fast to merge. Wouldn't be better to allow complex ordering? I suggest the following:

@ApiResource(attributes={"name": "DESC", "firstname": "ASC"})

(Order by name then by firstname). WDYT @vincentchalamon? Can you do a follow up PR?

[vincentchalamon]

I though about adding the multiple default ordering, but I wasn't sure it was very useful.
I would prefer a syntax like that:

@ApiResource(attributes={
    "order"={"name": "DESC", "firstname": "ASC"}
})

WDYT @dunglas? If so, I could open another PR to fix it.

[dunglas]

IMO it's useful (ordering by name then firstname is very common for instance). You're right for the syntax, my example is faulty (missing order key). A PR would be great!

[vincentchalamon]

#1323

[ahmed-bhs]

Guys thank you for this feature, does this support yaml configuration, I tried to add order to my resource, seems nothing work ! Any idea? @vincentchalamon

resources:
    App\Entity\Repos\EventFamily:
        collectionOperations:
            get:
                order: ["name", "DESC"]
                attributes:
                    order: ["name", "DESC"]

[vincentchalamon]

@ahmed-bhs Did you try the following configuration?:

resources:
    App\Entity\Repos\EventFamily:
        attributes:
            order: ["name", "DESC"]
        collectionOperations:
            get: ~

I didn't try this configuration in YAML since many years (this PR is older than 3 years).