Skip to content

Revert using defaults.order as collection.order #4178

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alanpoulain merged 4 commits into from
Mar 31, 2021
Merged

Revert using defaults.order as collection.order #4178

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d96adfa
Revert using defaults.order as collection.order
guilliamxavier Mar 31, 2021
bd15cfd
Revert test config order-related change
guilliamxavier Mar 31, 2021
99cfd42
Revert other order-related change
guilliamxavier Mar 31, 2021
ae86cc4
Revert other order-related change
guilliamxavier Mar 31, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/Bridge/Doctrine/MongoDbOdm/Extension/OrderExtension.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ public function applyToCollection(Builder $aggregationBuilder, string $resourceC
if (empty($defaultOrder)) {
$defaultOrder = $this->resourceMetadataFactory->create($resourceClass)->getAttribute('order');
}
if (\is_array($defaultOrder)) {
if (null !== $defaultOrder) {

@alanpoulain alanpoulain Mar 31, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't it better to keep is_array?

@guilliamxavier guilliamxavier Mar 31, 2021 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know, because:

  • I consistently reverted all the changes of 3492922
  • With null !== (like it was originally) an incorrect config (e.g. a string value) gives you a Warning "Invalid argument supplied for foreach()" (then you fix your config 😉), with is_array() it is silently ignored (until you notice your config isn't applied? 😕)
  • See also Fix behaviour of "order" attribute #3472

But if you deem this part of the revert too risky, I can drop it (just say it)

@alanpoulain alanpoulain Mar 31, 2021

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure which one is the better 😅 Keep it like this, it's alright.

foreach ($defaultOrder as $field => $order) {
if (\is_int($field)) {
// Default direction
Expand Down
2 changes: 1 addition & 1 deletion src/Bridge/Doctrine/Orm/Extension/OrderExtension.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ public function applyToCollection(QueryBuilder $queryBuilder, QueryNameGenerator
if (empty($defaultOrder)) {
$defaultOrder = $this->resourceMetadataFactory->create($resourceClass)->getAttribute('order');
}
if (\is_array($defaultOrder)) {
if (null !== $defaultOrder) {
foreach ($defaultOrder as $field => $order) {
if (\is_int($field)) {
// Default direction
Expand Down
2 changes: 1 addition & 1 deletion src/Bridge/Symfony/Bundle/DependencyInjection/ApiPlatformExtension.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ private function registerCommonConfiguration(ContainerBuilder $container, array
$container->setParameter('api_platform.eager_loading.fetch_partial', $config['eager_loading']['fetch_partial']);
$container->setParameter('api_platform.eager_loading.force_eager', $config['eager_loading']['force_eager']);
$container->setParameter('api_platform.collection.exists_parameter_name', $config['collection']['exists_parameter_name']);
$container->setParameter('api_platform.collection.order', $config['defaults']['order'] ?? $config['collection']['order']);
$container->setParameter('api_platform.collection.order', $config['collection']['order']);
$container->setParameter('api_platform.collection.order_parameter_name', $config['collection']['order_parameter_name']);
$container->setParameter('api_platform.collection.pagination.enabled', $config['defaults']['pagination_enabled'] ?? $this->isConfigEnabled($container, $config['collection']['pagination']));
$container->setParameter('api_platform.collection.pagination.partial', $config['defaults']['pagination_partial'] ?? $config['collection']['pagination']['partial']);
Expand Down
1 change: 0 additions & 1 deletion tests/Fixtures/app/config/config_common.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,6 @@ api_platform:
pagination_client_items_per_page: true
pagination_client_partial: true
pagination_items_per_page: 3
order: 'ASC'
cache_headers:
max_age: 60
shared_max_age: 3600
Expand Down