Fix api-platform/core #1246: configure default order on ApiResource annotation #235

vincentchalamon · 2017-08-18T21:09:04Z

No description provided.

dunglas · 2017-08-22T07:49:08Z

core/default-order.md

@@ -0,0 +1,37 @@
+# Override default order


What do you think about naming the file order.md or ordering.md and merging everything related to ordering (the global config option, the filter and this config option) in this file?

It will be easier to understand for a new comer IMP.

Btw the title must be in Title Case (Override Default Order)

I didn't explain this default order in the order filter cause it's a different feature. I better think we should mention it in the order filter and in the global config option, but keep it separated.

IMO having a specific doc for all ordering features would be better in term of understanding for a newcomer, it was my point.

dunglas · 2017-08-22T07:49:28Z

core/default-order.md

@@ -0,0 +1,37 @@
+# Override default order
+
+API Platform Core provides an easy way to override default order in your collection.


of the collections?

I think we can get rid of Core too.

of the collections

Why plural?

I took Core keyword from many .md files in this project. If we get rid of it, please open a new PR to remove it everywhere.

dunglas · 2017-08-22T07:52:30Z

core/default-order.md

+
+API Platform Core provides an easy way to override default order in your collection.
+
+By default, it will order by resource identifier(s) using ASC direction. If you want to customize this order, you must add an `order` attribute on your ApiResource annotation:


By default, it will order by resource identifier(s) using ASC direction.

IIRC, it's not true. By default don't change the order of the underlying DBMS, and it is not defined nor consistent: https://dba.stackexchange.com/a/6053

@ApiResource annotation. Maybe it is worth mentioning that it can also be configured using XML and YAML.

The Bridge/Doctrine/Orm/Extension/OrderExtension default order collection by identifier(s): https://github.com/api-platform/core/blob/master/src/Bridge/Doctrine/Orm/Extension/OrderExtension.php#L56

Ok it's a bit more complicated. It's ordered by default only if you use the Symfony bridge (https://github.com/api-platform/core/blob/master/src/Bridge/Symfony/Bundle/DependencyInjection/Configuration.php#L92), if you use the class directly, $this->order is null and the collection isn't ordered: https://github.com/api-platform/core/blob/master/src/Bridge/Doctrine/Orm/Extension/OrderExtension.php#L54

But ok to keep it as is.

dunglas · 2017-08-22T07:54:50Z

core/default-order.md

+use ApiPlatform\Core\Annotation\ApiResource;
+
+/**
+ * @ApiResource(attributes={"order"={"foo", "ASC"}})


See https://github.com/api-platform/core/pull/1321/files#r134408183

Cf. api-platform/core#1321 (comment)

@dunglas Could it be interesting to configure a default order by an association, like author.username?

dunglas · 2017-08-22T07:55:07Z

core/default-order.md

+
+    /**
+     * ...
+     * @ApiProperty()


This annotation is useless, you can remove it.

meyerbaptiste · 2017-09-11T09:19:06Z

core/default-order.md

+}
+```
+
+It's also possible to configure the default filter on an association property:


Can you remove this part? So we can merge your PR. We will add it when the api-platform/core#1324 will be merged.

…piResource annotation

teohhanhui · 2017-09-11T12:36:10Z

core/default-order.md

+
+API Platform Core provides an easy way to override default order in your collection.
+
+By default, it will order by resource identifier(s) using ASC direction. If you want to customize this order, you must add an `order` attribute on your ApiResource annotation:


By default, items in the collection are ordered in ascending (ASC) order by their resource identifier(s).

teohhanhui · 2017-09-11T12:38:20Z

core/default-order.md

@@ -0,0 +1,88 @@
+# Override Default Order
+
+API Platform Core provides an easy way to override default order in your collection.


... override the default order of items in your collection.

meyerbaptiste · 2017-09-11T13:03:03Z

Thanks @vincentchalamon, don't forget to add the removed paragraph when api-platform/core#1324 will be merged:

It's also possible to configure the default filter on an association property:

<?php

// src/AppBundle/Entity/Book.php

namespace AppBundle\Entity;

use ApiPlatform\Core\Annotation\ApiResource;

/**
 * @ApiResource(attributes={"order"={"author.username"}})
 */
class Book
{
    // ...

    /**
     * @var User
     */
    public $author;
}

vincentchalamon added the enhancement label Aug 18, 2017

vincentchalamon self-assigned this Aug 18, 2017

vincentchalamon requested review from dunglas and teohhanhui August 18, 2017 21:09

vincentchalamon mentioned this pull request Aug 18, 2017

Fix 1246: configure default order on ApiResource annotation api-platform/core#1321

Merged

dunglas requested changes Aug 22, 2017

View reviewed changes

This was referenced Aug 22, 2017

Issues/1246 api-platform/core#1323

Merged

[RFR] Issues/1246 api-platform/core#1324

Merged

meyerbaptiste reviewed Sep 11, 2017

View reviewed changes

vincentchalamon added 2 commits September 11, 2017 14:38

Fix api-platform/core api-platform#1246: configure default order on A…

3a1afe1

…piResource annotation

Update doc from new PR

b856b71

teohhanhui reviewed Sep 11, 2017

View reviewed changes

meyerbaptiste force-pushed the issues/1246 branch 2 times, most recently from c0f56b3 to 3207dfd Compare September 11, 2017 12:54

meyerbaptiste approved these changes Sep 11, 2017

View reviewed changes

Fix comments

208eb03

meyerbaptiste force-pushed the issues/1246 branch from 3207dfd to 208eb03 Compare September 11, 2017 12:56

meyerbaptiste merged commit 085869b into api-platform:master Sep 11, 2017

vincentchalamon deleted the issues/1246 branch September 11, 2017 12:59

		@@ -0,0 +1,37 @@
		# Override default order

		API Platform Core provides an easy way to override default order in your collection.

		@@ -0,0 +1,88 @@
		# Override Default Order

		API Platform Core provides an easy way to override default order in your collection.

Uh oh!

Fix api-platform/core #1246: configure default order on ApiResource annotation #235

Fix api-platform/core #1246: configure default order on ApiResource annotation #235

Uh oh!

Conversation

vincentchalamon commented Aug 18, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dunglas Aug 22, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

meyerbaptiste commented Sep 11, 2017

Uh oh!

Uh oh!

dunglas Aug 22, 2017 •

edited

Loading