Document search

dabrt · dabrt · commit 3958c12a5ef4 · 2025-04-16T18:30:44.000+02:00
diff --git a/docs/search/criteria_reference/discount_created_criterion.md b/docs/search/criteria_reference/discount_created_criterion.md
@@ -0,0 +1,25 @@
+---
+description: Discount CreatedAt Search Criterion
+edition: commerce
+---
+
+# Discount CreatedAt Criterion
+
+The `CreatedAtCriterion` Search Criterion searches for discounts based on the date when they were created.
+
+## Arguments
+
+- `createdAt` - date to be matched, provided as a `DateTimeInterface` object
+- `operator` - optional operator string (EQ, GT, GTE, LT, LTE)
+
+## Example
+
+### PHP
+
+``` php
+$criteria = new \Ibexa\Contracts\Discounts\Value\Query\Criterion\CreatedAtCriterion(
+    new DateTime('2025-04-11 14:07:02'), Operator::GTE
+);
+
+$discountQuery = new DiscountQuery($criteria);
+```
diff --git a/docs/search/criteria_reference/discount_creator_criterion.md b/docs/search/criteria_reference/discount_creator_criterion.md
@@ -0,0 +1,24 @@
+---
+description: Discount CreatorCriterion Search Criterion
+edition: commerce
+---
+
+# Creator Criterion
+
+The `CreatorCriterion` Criterion searches for discounts based on the user reference.
+
+## Arguments
+
+- `UserReference` object - \Ibexa\Contracts\Core\Repository\Values\User\UserReference(int $userId)
+
+## Example
+
+### PHP
+
+``` php
+$query = new DiscountQuery(
+    new \Ibexa\Contracts\Discounts\Value\Query\Criterion\CreatorCriterion(
+        \Ibexa\Core\Repository\Values\User\UserReference(14)
+    )
+);
+```
diff --git a/docs/search/criteria_reference/discount_enddate_criterion.md b/docs/search/criteria_reference/discount_enddate_criterion.md
@@ -0,0 +1,30 @@
+---
+description: Discount EndDate Search Criterion
+edition: commerce
+---
+
+# Discount EndDate Criterion
+
+The `EndDateCriterion` Search Criterion searches for discounts based on the date and time when they expire.
+
+## Arguments
+
+- `value` - searched value provided as the [DateTimeImmutable](https://www.php.net/manual/en/class.datetimeimmutable.php) object
+- `operator` - optional operator string (EQ, GT, GTE, LT, LTE)
+
+## Example
+
+### PHP
+
+``` php
+$criteria = new \Ibexa\Contracts\Discounts\Value\Query\Criterion\LogicalAnd(
+    new \Ibexa\Contracts\Discounts\Value\Query\Criterion\StartDateCriterion(
+        new DateTimeImmutable('2025-04-11 14:07:03'), Operator::GTE
+    ),
+    new \Ibexa\Contracts\Discounts\Value\Query\Criterion\EndDateCriterion(
+        new DateTimeImmutable('2027-04-11 14:07:02'), Operator::LTE
+    ),
+);
+
+$discountQuery = new DiscountQuery($criteria);
+```
diff --git a/docs/search/criteria_reference/discount_identifier_criterion.md b/docs/search/criteria_reference/discount_identifier_criterion.md
@@ -0,0 +1,22 @@
+---
+description: Discount Identifier Search Criterion
+edition: commerce
+---
+
+# Discount Identifier Criterion
+
+The `Identifier` Search Criterion searches for discounts based on the discount identifier.
+
+## Arguments
+
+- `identifier` - string that represents the discount identifier
+
+## Example
+
+### PHP
+
+``` php
+$criteria = new \Ibexa\Contracts\Discounts\Value\Query\Criterion\IdentifierCriterion('summer-sale');
+
+$discountQuery = new DiscountQuery($criteria);
+```
diff --git a/docs/search/criteria_reference/discount_isenabled_criterion.md b/docs/search/criteria_reference/discount_isenabled_criterion.md
@@ -0,0 +1,22 @@
+---
+description: Discount IsEnabled Search Criterion
+edition: commerce
+---
+
+# Discount IsEnabled Criterion
+
+The `IsEnabledCriterion` Search Criterion searches for discounts based on whether the discount is enabled or not.
+
+## Arguments
+
+- `value` - Boolean value stating whether the discount is enabled or not
+
+## Example
+
+### PHP
+
+``` php
+$criteria = new \Ibexa\Contracts\Discounts\Value\Query\Criterion\IsEnabledCriterion(true);
+
+$discountQuery = new DiscountQuery($criteria);
+```
diff --git a/docs/search/criteria_reference/discount_logicaland_criterion.md b/docs/search/criteria_reference/discount_logicaland_criterion.md
@@ -0,0 +1,29 @@
+---
+description: Discount LogicalAnd Search Criterion
+edition: commerce
+---
+
+# Discount LogicalAnd Criterion
+
+The `LogicalAnd` Search Criterion matches discounts if all provided Criteria match.
+
+## Arguments
+
+- `criterion` - a set of Criteria combined by the logical operator
+
+## Example
+
+### PHP
+
+``` php
+$criteria = new \Ibexa\Contracts\Discounts\Value\Query\Criterion\LogicalAnd(
+    new \Ibexa\Contracts\Discounts\Value\Query\Criterion\StartDateCriterion(
+        new DateTimeImmutable('2025-04-11 14:07:03'), Operator::GTE
+    ),
+    new \Ibexa\Contracts\Discounts\Value\Query\Criterion\EndDateCriterion(
+        new DateTimeImmutable('2027-04-11 14:07:02'), Operator::LTE
+    ),
+);
+
+$discountQuery = new DiscountQuery($criteria);
+```
diff --git a/docs/search/criteria_reference/discount_logicalor_criterion.md b/docs/search/criteria_reference/discount_logicalor_criterion.md
@@ -0,0 +1,25 @@
+---
+description: Discount LogicalOr Search Criterion
+edition: commerce
+---
+
+# Discount LogicalOr Criterion
+
+The `LogicalOr` Search Criterion matches discounts if at least one of the provided Criteria matches.
+
+## Arguments
+
+- `criterion` - a set of Criteria combined by the logical operator
+
+## Example
+
+### PHP
+
+``` php
+$criteria = new LogicalOr(
+    new StartDateCriterion(new DateTimeImmutable('2025-04-11 14:07:03'), Operator::GTE),
+    new CreatedAtCriterion(new DateTime('2025-04-11 14:07:02'), Operator::GTE),
+);
+
+$discountQuery = new DiscountQuery($criteria);
+```
diff --git a/docs/search/criteria_reference/discount_name_criterion.md b/docs/search/criteria_reference/discount_name_criterion.md
@@ -0,0 +1,22 @@
+---
+description: Discount NameCriterion Search Criterion
+edition: commerce
+---
+
+# Discount Name Criterion
+
+The `NameCriterion` Search Criterion searches for discounts based on the discount name.
+
+## Arguments
+
+- `value` - string that represents the discount name
+
+## Example
+
+### PHP
+
+``` php
+$criteria = new \Ibexa\Contracts\Discounts\Value\Query\Criterion\NameCriterion('Summer sale');
+
+$discountQuery = new DiscountQuery($criteria);
+```
diff --git a/docs/search/criteria_reference/discount_priority_criterion.md b/docs/search/criteria_reference/discount_priority_criterion.md
@@ -0,0 +1,22 @@
+---
+description: Discount PriorityCriterion Search Criterion
+edition: commerce
+---
+
+# Priority Criterion
+
+The `PriorityCriterion` Criterion searches for discounts based on their priority.
+
+## Arguments
+
+- `value` - numerical value representing the discount's priority
+
+## Example
+
+### PHP
+
+``` php
+$criteria = new \Ibexa\Contracts\Discounts\Value\Query\Criterion\PriorityCriterion(5);
+
+$discountQuery = new DiscountQuery($criteria);
+```
diff --git a/docs/search/criteria_reference/discount_search_criteria.md b/docs/search/criteria_reference/discount_search_criteria.md
@@ -0,0 +1,26 @@
+---
+description: Discount Search Criteria
+edition: commerce
+---
+
+# Discount Search Criteria reference
+
+Discount Search Criteria are only supported by [Discount Search (`DiscountService::findDiscounts`)](discounts_api.md#get-multiple-discounts).
+
+With these Criteria you can filter discounts, for example, by their discount identifier, name, creation date, discount status, priority, or type.
+
+## Discount Search Criteria
+
+|Search Criterion|Search based on|
+|-----|-----|
+|[CreatedAtCriterion](discount_created_criterion.md)|Date and time when the discount was created|
+|[CreatorCriterion](discount_creator_criterion.md)|User who created the discount|
+|[EndDateCriterion](discount_end_date_criterion.md)|Date and time when the discount expires|
+|[IdentifierCriterion](discount_identifier_criterion.md)|Discount identifier|
+|[IsEnabledCriterion](discount_is_enabled_criterion.md)|Whether the discount is enabled or not|
+|[LogicalAndCriterion](discount_logicaland_criterion.md)|Owner based on the user reference|
+|[LogicalOrCriterion](discount_logicalor_criterion.md)|Owner based on the user reference|
+|[NameCriterion](discount_name_criterion.md)|The name of the discount|
+|[PriorityCriterion](discount_priority_criterion.md)|Priority value of the discount|
+|[StartDateCriterion](discount_start_date_criterion.md)|Date and time when the discount begins|
+|[TypeCriterion](discount_type_criterion.md)|Type value of the criterion|
diff --git a/docs/search/criteria_reference/discount_startdate_criterion.md b/docs/search/criteria_reference/discount_startdate_criterion.md
@@ -0,0 +1,30 @@
+---
+description: Discount StartDate Search Criterion
+edition: commerce
+---
+
+# Discount StartDate Criterion
+
+The `StartDateCriterion` Search Criterion searches for discounts based on the date and time when they begin.
+
+## Arguments
+
+- `value` - searched value provided as the [DateTimeImmutable](https://www.php.net/manual/en/class.datetimeimmutable.php) object
+- `operator` - optional operator string (EQ, GT, GTE, LT, LTE)
+
+## Example
+
+### PHP
+
+``` php
+$criteria = new \Ibexa\Contracts\Discounts\Value\Query\Criterion\LogicalAnd(
+    new \Ibexa\Contracts\Discounts\Value\Query\Criterion\StartDateCriterion(
+        new DateTimeImmutable('2025-04-11 14:07:03'), Operator::GTE
+    ),
+    new \Ibexa\Contracts\Discounts\Value\Query\Criterion\EndDateCriterion(
+        new DateTimeImmutable('2027-04-11 14:07:02'), Operator::LTE
+    ),
+);
+
+$discountQuery = new DiscountQuery($criteria);
+```
diff --git a/docs/search/criteria_reference/discount_type_criterion.md b/docs/search/criteria_reference/discount_type_criterion.md
@@ -0,0 +1,22 @@
+---
+description: Discount TypeCriterion Search Criterion
+edition: commerce
+---
+
+# Discount Type Criterion
+
+The `TypeCriterion` Search Criterion searches for discounts based on the discount type.
+
+## Arguments
+
+- `value` - string that represents the discount type
+
+## Example
+
+### PHP
+
+``` php
+$criteria = new \Ibexa\Contracts\Discounts\Value\Query\Criterion\TypeCriterion('catalog');
+
+$discountQuery = new DiscountQuery($criteria);
+```
diff --git a/docs/search/sort_clause_reference/discount_createdat_sort_clause.md b/docs/search/sort_clause_reference/discount_createdat_sort_clause.md
@@ -0,0 +1,36 @@
+---
+description: Discount CreatedAt Sort Clause
+edition: commerce
+---
+
+# Discount CreatedAt Sort Clause
+
+The `CreatedAt` Sort Clause sorts search results by the date and time when the discount was created.
+
+## Arguments
+
+- (optional) `sortDirection` - `CreatedAt` constant, either `CreatedAt::SORT_ASC` or `CreatedAt::SORT_DESC`
+
+## Example
+
+``` php
+new \Ibexa\Contracts\Discounts\Value\Query\DiscountQuery(
+    null,
+    [new \Ibexa\Contracts\Discounts\Value\Query\SortClause\CreatedAt(\Ibexa\Contracts\CoreSearch\Values\Query\AbstractSortClause::SORT_ASC)],
+),
+10,
+static function (\Ibexa\Contracts\Discounts\Value\DiscountListInterface $discountList): void {
+    $timestamps = array_map(
+        static fn (\Ibexa\Contracts\Discounts\Value\DiscountInterface $discount): DateTimeInterface => $discount->getCreatedAt(),
+        $discountList->getDiscounts()
+    );
+
+    self::assertEquals(
+        [
+            new DateTimeImmutable('2024-11-20 14:07:04'),
+            new DateTimeImmutable('2024-11-20 14:07:04'),
+        ],
+        $timestamps
+    );
+}
+```
diff --git a/docs/search/sort_clause_reference/discount_id_sort_clause.md b/docs/search/sort_clause_reference/discount_id_sort_clause.md
@@ -0,0 +1,30 @@
+---
+description: Discount Id Sort Clause
+edition: commerce
+---
+
+# Discount Id Sort Clause
+
+The `Id` Sort Clause sorts search results by discount ID.
+
+## Arguments
+
+- (optional) `sortDirection` - `Id` constant, either `Id::SORT_ASC` or `Id::SORT_DESC`
+
+## Example
+
+``` php
+new \Ibexa\Contracts\Discounts\Value\Query\DiscountQuery(
+        null,
+        [new \Ibexa\Contracts\Discounts\Value\Query\SortClause\Id(AbstractSortClause::SORT_DESC)],
+    ),
+    10,
+    static function (\Ibexa\Contracts\Discounts\Value\DiscountListInterface $discountList): void {
+        $ids = array_map(
+            static fn (\Ibexa\Contracts\Discounts\Value\DiscountInterface $discount): int => $discount->getId(),
+            $discountList->getDiscounts()
+        );
+
+        self::assertSame([10, 7, 3, 1], $ids);
+    }
+```
diff --git a/docs/search/sort_clause_reference/discount_identifier_sort_clause.md b/docs/search/sort_clause_reference/discount_identifier_sort_clause.md
diff --git a/docs/search/sort_clause_reference/discount_priority_sort_clause.md b/docs/search/sort_clause_reference/discount_priority_sort_clause.md
diff --git a/docs/search/sort_clause_reference/discount_type_sort_clause.md b/docs/search/sort_clause_reference/discount_type_sort_clause.md
diff --git a/docs/search/sort_clause_reference/discount_updatedat_sort_clause.md b/docs/search/sort_clause_reference/discount_updatedat_sort_clause.md
diff --git a/docs/search/sort_clause_reference/discounts_enddate_sort_clause.md b/docs/search/sort_clause_reference/discounts_enddate_sort_clause.md
diff --git a/docs/search/sort_clause_reference/discounts_startdate_sort_clause.md b/docs/search/sort_clause_reference/discounts_startdate_sort_clause.md
