Skip to content
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.

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

Add joins on the orders list query builder conditionally #15132

Merged
merged 2 commits into from
Jul 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions UPGRADE-1.13.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,3 +114,7 @@

All internal usages of service `sylius.product_variant_resolver.default` have been switched to `Sylius\Component\Product\Resolver\ProductVariantResolverInterface`, if you have been using the
`sylius.product_variant_resolver.default` service apply this change accordingly.

1. Due to optimizations of the Order's grid the `Sylius\Component\Core\Repository\OrderRepositoryInterface::createSearchListQueryBuilder` method bas been deprecated and replaced by `Sylius\Component\Core\Repository\OrderRepositoryInterface::createCriteriaAwareSearchListQueryBuilder`.
Also `Sylius\Component\Core\Repository\OrderRepositoryInterface::createByCustomerIdQueryBuilder` has been deprecated and replaced by `Sylius\Component\Core\Repository\OrderRepositoryInterface::createByCustomerIdCriteriaAwareQueryBuilder` for the same reason. Both changes affect
`sylius_admin_order` and `sylius_admin_customer_order` grids configuration.
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sylius_grid:
driver:
options:
repository:
method: createByCustomerIdQueryBuilder
method: createByCustomerIdCriteriaAwareQueryBuilder
arguments:
customerId: $id
fields:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ sylius_grid:
options:
class: "%sylius.model.order.class%"
repository:
method: createSearchListQueryBuilder
method: createCriteriaAwareSearchListQueryBuilder
arguments:
criteria: $criteria
sorting:
number: desc
fields:
Expand Down
37 changes: 37 additions & 0 deletions src/Sylius/Bundle/CoreBundle/Doctrine/ORM/OrderRepository.php
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,33 @@ public function createSearchListQueryBuilder(): QueryBuilder
;
}

public function createCriteriaAwareSearchListQueryBuilder(?array $criteria): QueryBuilder
{
if ($criteria === null) {
return $this->createListQueryBuilder();
}

$hasProductCriteria = '' !== $criteria['product'];
$hasVariantCriteria = '' !== $criteria['variant'];

$queryBuilder = $this->createListQueryBuilder();

if ($hasVariantCriteria || $hasProductCriteria) {
$queryBuilder
->leftJoin('o.items', 'item')
->leftJoin('item.variant', 'variant')
;
}

if ($hasProductCriteria) {
$queryBuilder
->leftJoin('variant.product', 'product')
;
}

return $queryBuilder;
}

public function createByCustomerIdQueryBuilder($customerId): QueryBuilder
{
return $this->createListQueryBuilder()
Expand All @@ -73,6 +100,16 @@ public function createByCustomerIdQueryBuilder($customerId): QueryBuilder
;
}

public function createByCustomerIdCriteriaAwareQueryBuilder(?array $criteria, string $customerId): QueryBuilder
{
$queryBuilder = $this->createCriteriaAwareSearchListQueryBuilder($criteria);

return $queryBuilder
->andWhere('o.customer = :customerId')
->setParameter('customerId', $customerId)
;
}

public function createByCustomerAndChannelIdQueryBuilder($customerId, $channelId): QueryBuilder
{
return $this->createQueryBuilder('o')
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,26 @@ interface OrderRepositoryInterface extends BaseOrderRepositoryInterface
{
public function createListQueryBuilder(): QueryBuilder;

/**
* @deprecated since 1.13 and will be removed in Sylius 2.0. Use {@see createCriteriaAwareSearchListQueryBuilder()} instead.
*/
public function createSearchListQueryBuilder(): QueryBuilder;

/**
* @param array{product: string, variant: string}|null $criteria
*/
public function createCriteriaAwareSearchListQueryBuilder(?array $criteria): QueryBuilder;

/**
* @deprecated since 1.13 and will be removed in Sylius 2.0. Use {@see createByCustomerIdCriteriaAwareQueryBuilder()} instead.
*/
public function createByCustomerIdQueryBuilder($customerId): QueryBuilder;

/**
* @param array{product: string, variant: string}|null $criteria
*/
public function createByCustomerIdCriteriaAwareQueryBuilder(?array $criteria, string $customerId): QueryBuilder;

public function createByCustomerAndChannelIdQueryBuilder($customerId, $channelId): QueryBuilder;

public function countByCustomerAndCoupon(CustomerInterface $customer, PromotionCouponInterface $coupon): int;
Expand Down