[Discounts] Search overview

[mnocon]

Added documentation for:

1. Search sort clauses
2. Search criteria

Preview:

• docs/search/discounts_search_reference/discounts_criteria.md
• docs/search/discounts_search_reference/discounts_sort_clauses.md

[github-actions]

Preview of modified files

Preview of modified Markdown:

• docs/search/discounts_search_reference/discounts_criteria.md
• docs/search/discounts_search_reference/discounts_sort_clauses.md

[konradoboza]

One fundamental issue I was able to spot:

[mnocon]

@konradoboza Your comment made me realise that I've presented it in a potentially confusing way.

When discounts are prioritized, cart discounts are applied before catalog discounts:
https://github.com/ibexa/discounts/blob/main/src/lib/DiscountPrioritizationStrategy.php#L24C17-L24C21

So in "prioritization" sense, cart ranks higher than catalog - as you write.

But the "Type" sort clause uses the ascending order by default - so if cart is returned first, then cart ranks lower than catalog, in "sort clause sorting" sense.

In my head I have an example like this:

• cart - value 0
• catalog - value 1

When sorting ascending, cart is returned before catalog - and catalog ranks "higher" than cart.
Lower ranks are returned first when sorting ascending - cart is returned before catalog.

I think this is where the confusion comes from - that the "prioritization" and "sort clause" rankings are inverted, thank for you for spotting how confusing it can be 😄

I've reworded it in bcc88ab , I hope it's better

[github-actions]

code_samples/ change report

Before (on target branch)	After (in current PR)
code_samples/discounts/src/Query/Search.php	code_samples/discounts/src/Query/Search.php
	docs/search/discounts_search_reference/discounts_criteria.md@32:```php hl_lines="13-20" docs/search/discounts_search_reference/discounts_criteria.md@33:[[= include_file('code_samples/discounts/src/Query/Search.php') =]] docs/search/discounts_search_reference/discounts_criteria.md@34:``` 001⫶<?php 002⫶ 003⫶declare(strict_types=1); 004⫶ 005⫶use Ibexa\Contracts\CoreSearch\Values\Query\Criterion\FieldValueCriterion; 006⫶use Ibexa\Contracts\Discounts\Value\Query\Criterion; 007⫶use Ibexa\Contracts\Discounts\Value\Query\DiscountQuery; 008⫶use Ibexa\Contracts\Discounts\Value\Query\SortClause; 009⫶ 010⫶$now = new DateTimeImmutable(); 011⫶ 012⫶$query = new DiscountQuery( 013❇️ new Criterion\LogicalAnd( 014❇️ new Criterion\IsEnabledCriterion(), 015❇️ new Criterion\StartDateCriterion($now, FieldValueCriterion::COMPARISON_LTE), 016❇️ new Criterion\LogicalOr( 017❇️ new Criterion\EndDateCriterion($now, FieldValueCriterion::COMPARISON_GTE), 018❇️ new Criterion\EndDateCriterion(null, FieldValueCriterion::COMPARISON_EQ) 019❇️ ), 020❇️ ), 021⫶ [ 022⫶ new SortClause\Type(), 023⫶ new SortClause\Priority(), 024⫶ new SortClause\CreatedAt(), 025⫶ ] 026⫶); 027⫶ 028⫶/** @var \Ibexa\Contracts\Discounts\DiscountServiceInterface $discountService */ 029⫶$results = $discountService->findDiscounts($query); docs/search/discounts_search_reference/discounts_sort_clauses.md@25:```php hl_lines="22-24" docs/search/discounts_search_reference/discounts_sort_clauses.md@26:[[= include_file('code_samples/discounts/src/Query/Search.php') =]] docs/search/discounts_search_reference/discounts_sort_clauses.md@27:``` 001⫶<?php 002⫶ 003⫶declare(strict_types=1); 004⫶ 005⫶use Ibexa\Contracts\CoreSearch\Values\Query\Criterion\FieldValueCriterion; 006⫶use Ibexa\Contracts\Discounts\Value\Query\Criterion; 007⫶use Ibexa\Contracts\Discounts\Value\Query\DiscountQuery; 008⫶use Ibexa\Contracts\Discounts\Value\Query\SortClause; 009⫶ 010⫶$now = new DateTimeImmutable(); 011⫶ 012⫶$query = new DiscountQuery( 013⫶ new Criterion\LogicalAnd( 014⫶ new Criterion\IsEnabledCriterion(), 015⫶ new Criterion\StartDateCriterion($now, FieldValueCriterion::COMPARISON_LTE), 016⫶ new Criterion\LogicalOr( 017⫶ new Criterion\EndDateCriterion($now, FieldValueCriterion::COMPARISON_GTE), 018⫶ new Criterion\EndDateCriterion(null, FieldValueCriterion::COMPARISON_EQ) 019⫶ ), 020⫶ ), 021⫶ [ 022❇️ new SortClause\Type(), 023❇️ new SortClause\Priority(), 024❇️ new SortClause\CreatedAt(), 025⫶ ] 026⫶); 027⫶ 028⫶/** @var \Ibexa\Contracts\Discounts\DiscountServiceInterface $discountService */ 029⫶$results = $discountService->findDiscounts($query);

Download colorized diff

[julitafalcondusza]

Just a small remark.