Fix search criteria reference (#2927)

adriendupuis · web-flow · commit e6a341604365 · 2025-10-03T09:21:39.000+02:00
* Add IsContainer criterion
* visibility_criterion.md: Fix prop name in JSON
* contenttypegroupid_criterion.md: Remove unrelated REST example
* Fix REST ContentIdCriterion usage
* contenttypegroupid_criterion.md: You can't pass an array in XML
diff --git a/docs/search/criteria_reference/contentid_criterion.md b/docs/search/criteria_reference/contentid_criterion.md
@@ -25,7 +25,7 @@ $query->query = new Criterion\ContentId([62, 64]);
     ```xml
     <Query>
         <Filter>
-            <ContentIdCriterion>[69, 72]</ContentIdCriterion>
+            <ContentIdCriterion>1,52</ContentIdCriterion>
         </Filter>
     </Query>
     ```
@@ -35,7 +35,7 @@ $query->query = new Criterion\ContentId([62, 64]);
     ```json
     "Query": {
         "Filter": {
-            "ContentIdCriterion": [69, 72]
+            "ContentIdCriterion": "1,52"
         }
     }
     ```
diff --git a/docs/search/criteria_reference/contentname_criterion.md b/docs/search/criteria_reference/contentname_criterion.md
@@ -38,4 +38,4 @@ $query->query = new Criterion\ContentName('*phone');
             "ContentNameCriterion": "*phone"
         }
     }
-    ```
+    ```
diff --git a/docs/search/criteria_reference/contenttypegroupid_criterion.md b/docs/search/criteria_reference/contenttypegroupid_criterion.md
@@ -25,7 +25,7 @@ $query->query = new Criterion\ContentTypeGroupId([1, 2]);
     ```xml
     <Query>
         <Filter>
-            <ContentTypeGroupIdCriterion>[1, 2]</ContentTypeGroupIdCriterion>
+            <ContentTypeGroupIdCriterion>1</ContentTypeGroupIdCriterion>
         </Filter>
     </Query>
     ```
@@ -55,25 +55,3 @@ You can use the `ContentTypeGroupId` Criterion to query all Media content items
         }
     }
 ```
-
-### REST API
-
-=== "XML"
-
-    ```xml
-      <Query>
-        <Filter>
-            <ContentIdCriterion>[69, 72]</ContentIdCriterion>
-        </Filter>
-      </Query>
-    ```
-
-=== "JSON"
-
-    ```json
-    "Query": {
-        "Filter": {
-            "ContentIdCriterion": [69, 72]
-            }
-        }
-    ```
diff --git a/docs/search/criteria_reference/datemetadata_criterion.md b/docs/search/criteria_reference/datemetadata_criterion.md
@@ -54,7 +54,6 @@ $query->query = new Criterion\DateMetadata(
         }
     ```
 
-
 ## Use case
 
 You can use the `DateMetadata` Criterion to search for blog posts that have been created within the last week:
diff --git a/docs/search/criteria_reference/datetimeattributerange_criterion.md b/docs/search/criteria_reference/datetimeattributerange_criterion.md
@@ -18,7 +18,6 @@ The [`DateTimeAttributeRange Search Criterion`](/api/php_api/php_api_reference/c
 
 The following example lists all products for which the `event_date` attribute has value greater than 2025-01-01.
 
-
 ``` php
 [[= include_file('code_samples/back_office/search/src/Query/DateTimeAttributeRangeQuery.php') =]]
 ```
diff --git a/docs/search/criteria_reference/field_criterion.md b/docs/search/criteria_reference/field_criterion.md
@@ -21,7 +21,6 @@ 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
diff --git a/docs/search/criteria_reference/fulltext_criterion.md b/docs/search/criteria_reference/fulltext_criterion.md
@@ -2,7 +2,6 @@
 description: FullText Search Criterion
 ---
 
-
 # FullText Criterion
 
 The [`FullText` Search Criterion](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Values-Content-Query-Criterion-FullText.html) searches for content based on the full text content of its fields.
@@ -27,7 +26,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
diff --git a/docs/search/criteria_reference/image_criterion.md b/docs/search/criteria_reference/image_criterion.md
@@ -118,4 +118,4 @@ $query->query = new Criterion\Image('image', $imageCriteriaData);
           }
        }
     }
-    ```
+    ```
diff --git a/docs/search/criteria_reference/imagedimensions_criterion.md b/docs/search/criteria_reference/imagedimensions_criterion.md
@@ -70,4 +70,4 @@ $query->query = new Criterion\Dimensions('image', $imageCriteriaData);
             }
         }
     }
-    ```
+    ```
diff --git a/docs/search/criteria_reference/imagefilesize_criterion.md b/docs/search/criteria_reference/imagefilesize_criterion.md
@@ -52,4 +52,4 @@ $query->query = new Criterion\FileSize('image', 0, 1.5);
             }
         }
     }
-    ```
+    ```
diff --git a/docs/search/criteria_reference/imagemimetype_criterion.md b/docs/search/criteria_reference/imagemimetype_criterion.md
@@ -67,4 +67,4 @@ $query->query = new Criterion\MimeType('image', $mimeTypes);
             }
         }
     }
-    ```
+    ```
diff --git a/docs/search/criteria_reference/imageorientation_criterion.md b/docs/search/criteria_reference/imageorientation_criterion.md
@@ -66,4 +66,4 @@ $query->query = new Criterion\Orientation('image', $orientations);
             }
         }
     }
-    ```
+    ```
diff --git a/docs/search/criteria_reference/iscontainer_criterion.md b/docs/search/criteria_reference/iscontainer_criterion.md
@@ -0,0 +1,20 @@
+---
+description: IsContainer Search Criterion
+---
+
+# IsContainer Criterion
+
+The [`IsContainer` Search Criterion](/api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Values-Content-Query-Criterion-IsContainer.html) searches for content items based on whether they are containers (i.e., can contain other content items).
+
+## Arguments
+
+- `value` – boolean (optional, default: `true`). If `true`, searches for content that is a container. If `false`, searches for content that is not a container.
+
+## Example
+
+### PHP
+
+```php
+$query->query = new Criterion\IsContainer(); // Finds containers
+$query->query = new Criterion\IsContainer(false); // Finds non-containers
+```
diff --git a/docs/search/criteria_reference/parentlocationremoteId_criterion.md b/docs/search/criteria_reference/parentlocationremoteId_criterion.md
@@ -10,7 +10,6 @@ The `ParentLocationRemoteId` Search Criterion searches for content based on the
 
 - `value` - int(s) representing the parent location remote IDs
 
-
 ### REST API
 
 === "XML"
diff --git a/docs/search/criteria_reference/productstock_criterion.md b/docs/search/criteria_reference/productstock_criterion.md
@@ -28,5 +28,3 @@ $productQuery = new ProductQuery(
     new Criterion\ProductStock(50, '>=')
 );
 ```
-
-
diff --git a/docs/search/criteria_reference/productstockrange_criterion.md b/docs/search/criteria_reference/productstockrange_criterion.md
@@ -21,5 +21,3 @@ $productQuery = new ProductQuery(
     new Criterion\ProductStockRange(10, 120)
 );
 ```
-
-
diff --git a/docs/search/criteria_reference/search_criteria_reference.md b/docs/search/criteria_reference/search_criteria_reference.md
@@ -43,6 +43,7 @@ Due to this storage limitation, searching content using the Country field type o
 | [ImageOrientation](imageorientation_criterion.md)             | Image orientation                                                                           | &#10004;       | &#10004;        |           |          |
 | [ImageWidth](imagewidth_criterion.md)                         | Image width in pixels                                                                       | &#10004;       | &#10004;        |           |          |
 | [IsBookmarked](isbookmarked_criterion.md)                     | Whether a location is bookmarked or not                                                     |                | &#10004;        | &#10004;  |          |
+| [IsContainer](iscontainer_criterion.md)                       | Whether a content item is a container (can contain other content items)                     | &#10004;       | &#10004;        | &#10004;  |          |
 | [IsCurrencyEnabledCriterion](iscurrencyenabled_criterion.md)  | Whether a specified currency is enabled in the system                                       |                |                 |           |          |
 | [IsFieldEmpty](isfieldempty_criterion.md)                     | Whether a specified field of a content item is empty or not                                 | &#10004;       | &#10004;        |           |          |
 | [IsMainLocation](ismainlocation_criterion.md)                 | Whether a location is the main location of a content item                                   |                | &#10004;        | &#10004;  |          |
diff --git a/docs/search/criteria_reference/visibility_criterion.md b/docs/search/criteria_reference/visibility_criterion.md
@@ -41,7 +41,7 @@ $query->query = new Criterion\Visibility(Criterion\Visibility::HIDDEN);
     ```json
     "Query": {
         "Filter": {
-            "ContentIdCriterion": "HIDDEN"
+            "VisibilityCriterion": "HIDDEN"
         }
     }
     ```
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -530,6 +530,7 @@ nav:
             - ImageOrientation: search/criteria_reference/imageorientation_criterion.md
             - ImageWidth: search/criteria_reference/imagewidth_criterion.md
             - IsBookmarked: search/criteria_reference/isbookmarked_criterion.md
+            - IsContainer: search/criteria_reference/iscontainer_criterion.md
             - IsCurrencyEnabled: search/criteria_reference/iscurrencyenabled_criterion.md
             - IsFieldEmpty: search/criteria_reference/isfieldempty_criterion.md
             - IsMainLocation: search/criteria_reference/ismainlocation_criterion.md

Original file line number	Diff line number	Diff line change
`@@ -38,4 +38,4 @@ $query->query = new Criterion\ContentName('*phone');`
`38`	`38`	`"ContentNameCriterion": "*phone"`
`39`	`39`	`}`
`40`	`40`	`}`
`41`		- ```
	`41`	+ ```
Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,6 @@ $query->query = new Criterion\DateMetadata(`
`54`	`54`	`}`
`55`	`55`	```
`56`	`56`
`57`		`-`
`58`	`57`	`## Use case`
`59`	`58`
`60`	`59`	You can use the `DateMetadata` Criterion to search for blog posts that have been created within the last week:
Original file line number	Diff line number	Diff line change
`@@ -118,4 +118,4 @@ $query->query = new Criterion\Image('image', $imageCriteriaData);`
`118`	`118`	`}`
`119`	`119`	`}`
`120`	`120`	`}`
`121`		- ```
	`121`	+ ```
Original file line number	Diff line number	Diff line change
`@@ -70,4 +70,4 @@ $query->query = new Criterion\Dimensions('image', $imageCriteriaData);`
`70`	`70`	`}`
`71`	`71`	`}`
`72`	`72`	`}`
`73`		- ```
	`73`	+ ```
Original file line number	Diff line number	Diff line change
`@@ -52,4 +52,4 @@ $query->query = new Criterion\FileSize('image', 0, 1.5);`
`52`	`52`	`}`
`53`	`53`	`}`
`54`	`54`	`}`
`55`		- ```
	`55`	+ ```