Hackathon: Unify & complete criteria reference

docs/search/criteria_reference/_template.md

@@ -0,0 +1,48 @@
+---
+description: [Short description of the criterion]
+# edition: [optional: edition, e.g. commerce]
+---
+
+# [Criterion Name] Criterion
+
+[Short description of what this criterion does.]
+
+## Arguments
+
+- `[argument1]` - [description of argument1]
+- `[argument2]` - [description of argument2]
+- ...
+
+## Supported syntax
+
+[Describe supported syntax, if relevant]
+
+## Limitations
+
+[Describe any limitations here]
+
+## Example
+
+### PHP
+
+```php
+// Example PHP usage
+```
+
+### REST API
+
+=== "XML"
+
+    ```xml
+    <!-- Example XML usage -->
+    ```
+
+=== "JSON"
+
+    ```json
+    // Example JSON usage
+    ```
+
+## Use case
+
+[Describe a use case here]

docs/search/criteria_reference/ancestor_criterion.md

@@ -10,12 +10,18 @@
 
 - `value` - array of location pathStrings
 
+## Limitations
+
+`Ancestor` can be used on all search engines.
+
 ## Example
 
 ### PHP
 
-``` php
-$query->query = new Criterion\Ancestor([$this->locationService->loadLocation(62)->pathString]);
+```php
+$query->query = new Criterion\Ancestor([
+    $this->locationService->loadLocation(62)->pathString
+]);
 ```
 
 ### REST API
@@ -44,9 +50,11 @@
 
 You can use the Ancestor Search Criterion to create a list of breadcrumbs leading to the Location:
 
-``` php hl_lines="2"
+```php hl_lines="2-4"
 $query = new LocationQuery();
-$query->query = new Criterion\Ancestor([$this->locationService->loadLocation($locationId)->pathString]);
+$query->query = new Criterion\Ancestor([
+    $this->locationService->loadLocation($locationId)->pathString
+]);
 
 $results = $this->searchService->findLocations($query);
 $breadcrumbs = [];
@@ -59,7 +67,7 @@
 ]);
 ```
 
-``` html+twig
+```html+twig
 {% for breadcrumb in breadcrumbs %}
     {% if not loop.first %} -> {% endif %}
     {% if not loop.last %}

docs/search/criteria_reference/contentid_criterion.md

@@ -10,11 +10,15 @@
 
 - `value` - int(s) representing the Content ID(s)
 
+## Limitations
+
+`ContentId` can be used on all search engines.
+
 ## Example
 
 ### PHP
 
-``` php
+```php
 $query->query = new Criterion\ContentId([62, 64]);
 ```
 

docs/search/criteria_reference/contentname_criterion.md

@@ -10,11 +10,15 @@
 
 - `value` - string representing the content name, the wildcard character `*` can be used for partial search
 
+## Limitations
+
+`ContentName` can be used on all search engines.
+
 ## Example
 
 ### PHP
 
-``` php
+```php
 $query->query = new Criterion\ContentName('*phone');
 ```
 
@@ -38,4 +42,4 @@
             "ContentNameCriterion": "*phone"
         }
     }
-    ```
+    ```

docs/search/criteria_reference/contenttypegroupid_criterion.md

@@ -10,11 +10,15 @@
 
 - `value` - int(s) representing the content type group ID(s)
 
+## Limitations
+
+`ContentTypeGroupId` can be used on all search engines.
+
 ## Example
 
 ### PHP
 
-``` php
+```php
 $query->query = new Criterion\ContentTypeGroupId([1, 2]);
 ```
 

docs/search/criteria_reference/contenttypeid_criterion.md

@@ -10,11 +10,15 @@
 
 - `value` - int(s) representing the content type ID(s)
 
+## Limitations
+
+`ContentTypeId` can be used on all search engines.
+
 ## Example
 
 ### PHP
 
-``` php
+```php
 $query->query = new Criterion\ContentTypeId([44]);
 ```
 

docs/search/criteria_reference/contenttypeidentifier_criterion.md

@@ -10,11 +10,15 @@
 
 - `value` - string(s) representing the content type identifier(s)
 
+## Limitations
+
+`ContentTypeIdentifier` can be used on all search engines.
+
 ## Example
 
 ### PHP
 
-``` php
+```php
 $query->query = new Criterion\ContentTypeIdentifier(['article', 'blog_post']);
 ```
 

docs/search/criteria_reference/currencycode_criterion.md

@@ -18,6 +18,6 @@ The `CurrencyCodeCriterion` Criterion isn't available in Solr or Elasticsearch e
 
 ### PHP
 
-``` php
+```php
 $query->query = new \Ibexa\Contracts\ProductCatalog\Values\Currency\Query\Criterion\CurrencyCodeCriterion('EUR');
 ```

docs/search/criteria_reference/customergroupid_criterion.md

@@ -10,10 +10,14 @@
 
 - `value` - int(s) representing the customer group ID(s)
 
+## Limitations
+
+`CustomerGroupId` can be used on all search engines.
+
 ## Example
 
 ### PHP
 
-``` php
+```php
 $query->query = new Criterion\CustomerGroupId(1);
 ```

docs/search/criteria_reference/datemetadata_criterion.md

@@ -12,11 +12,15 @@
 - `operator` - Operator constant (IN, EQ, GT, GTE, LT, LTE, BETWEEN)
 - `value` - indicating the date(s) that should be matched, provided as a UNIX timestamp (or array of timestamps)
 
+## Limitations
+
+`DateMetadata` can be used on all search engines.
+
 ## Example
 
 ### PHP
 
-``` php
+```php
 $query->query = new Criterion\DateMetadata(
     Criterion\DateMetadata::CREATED,
     Criterion\Operator::BETWEEN,

docs/search/criteria_reference/depth_criterion.md

@@ -19,10 +19,14 @@
 - exactly two ints for `Operator::BETWEEN`
 - a single int for other Operators
 
+## Limitations
+
+`Depth` can be used on all search engines.
+
 ## Example
 
 ### PHP
 
-``` php
+```php
 $query->query = new Criterion\Location\Depth(Criterion\Operator::LT, 3);
 ```

docs/search/criteria_reference/field_criterion.md

@@ -21,12 +21,11 @@ Querying for a collection with the `EQ` operator returns result only when the wh
 
 The `Field` Criterion isn't available in [Repository filtering](search_api.md#repository-filtering).
 
-
 ## Example
 
 ### PHP
 
-``` php
+```php
 $query->query = new Criterion\Field('name', Criterion\Operator::CONTAINS, 'Platform');
 ```
 

docs/search/criteria_reference/fieldrelation_criterion.md

@@ -22,6 +22,6 @@ The `FieldRelation` Criterion isn't available in [Repository filtering](search_a
 
 ### PHP
 
-``` php
+```php
 $query->query = new Criterion\FieldRelation('relations', Criterion\Operator::CONTAINS, [55, 63]);
 ```

docs/search/criteria_reference/fulltext_criterion.md

@@ -27,7 +27,6 @@ The [`FullText` Search Criterion](/api/php_api/php_api_reference/classes/Ibexa-C
 
 \*\*\* Asteriks may only be located at the beginning or end of a query.
 
-
 ## Limitations
 
 When using the Legacy search engine, a full text query performs an OR query by default, and
@@ -41,19 +40,19 @@ The `FullText` Criterion isn't available in [Repository filtering](search_api.md
 
 ### PHP
 
-``` php
+```php
 $query->query = new Criterion\FullText('victory');
 ```
 
 Using double quotes to indicate a phrase:
 
-``` php
+```php
 $query->query = new Criterion\FullText('"world cup"');
 ```
 
 Using the AND operator and parenthesis to search for both words at the same time:
 
-``` php
+```php
 $query->query = new Criterion\FullText('baseball AND cup');
 ```
 

docs/search/criteria_reference/image_criterion.md

@@ -11,11 +11,15 @@
 - `fieldDefIdentifier` - string representing the identifier of the field
 - `imageCriteriaData` - array representing image attributes. All attributes are optional.
 
+## Limitations
+
+`Image` can be used on all search engines.
+
 ## Example
 
 ### PHP
 
-``` php
+```php
 $imageCriteriaData = [
     'mimeTypes' => [
        'image/png',
@@ -118,4 +122,4 @@
           }
        }
     }
-    ```
+    ```

docs/search/criteria_reference/imagedimensions_criterion.md

@@ -11,11 +11,15 @@
 - `fieldDefIdentifier` - string representing the identifier of the field
 - `imageCriteriaData` - an array representing minimum and maximum values for width and height, expressed in pixels
 
+## Limitations
+
+`ImageDimensions` can be used on all search engines.
+
 ## Example
 
 ### PHP
 
-``` php
+```php
 $imageCriteriaData = [
     'width' => [
         'min' => 100, // (default: 0, optional)
@@ -70,4 +74,4 @@
             }
         }
     }
-    ```
+    ```

docs/search/criteria_reference/imagefilesize_criterion.md

@@ -12,11 +12,15 @@
 - (optional) `minValue` - numeric representing minimum file size expressed in MB, default: 0
 - (optional) `maxValue` - numeric representing maximum file size expressed in MB, default: `null`
 
+## Limitations
+
+`ImageFileSize` can be used on all search engines.
+
 ## Example
 
 ### PHP
 
-``` php
+```php
 $query->query = new Criterion\FileSize('image', 0, 1.5);
 ```
 
@@ -52,4 +56,4 @@
             }
         }
     }
-    ```
+    ```

docs/search/criteria_reference/imageheight_criterion.md

@@ -12,10 +12,14 @@
 - (optional) `minValue` - int representing minimum file height expressed in pixels, default: 0
 - (optional) `maxValue` - int representing maximum file height expressed in pixels, default: `null`
 
+## Limitations
+
+`ImageHeight` can be used on all search engines.
+
 ## Example
 
 ### PHP
 
-``` php
+```php
 $query->query = new Criterion\Height('image', 0, 1500);
 ```