From e8544d8c05945b8e8ca4caacf246f69c6756f009 Mon Sep 17 00:00:00 2001 From: julitafalcondusza <117284672+julitafalcondusza@users.noreply.github.com> Date: Fri, 14 Jun 2024 10:09:18 +0200 Subject: [PATCH] IBX-7418: `ContentName` search criterion added (#2364) * ContentName search criterion added * mkdocs updated * Fixes after review * Fixes * Fix * typo * Fix --- .../contentname_criterion.md | 38 +++++++++++++++++++ .../search_criteria_reference.md | 1 + mkdocs.yml | 1 + 3 files changed, 40 insertions(+) create mode 100644 docs/search/criteria_reference/contentname_criterion.md diff --git a/docs/search/criteria_reference/contentname_criterion.md b/docs/search/criteria_reference/contentname_criterion.md new file mode 100644 index 0000000000..b9f72819b4 --- /dev/null +++ b/docs/search/criteria_reference/contentname_criterion.md @@ -0,0 +1,38 @@ +# ContentName Criterion + +The [`ContentName` Search Criterion](https://github.com/ibexa/core/blob/main/src/contracts/Repository/Values/Content/Query/Criterion/ContentName.php) +searches for content by its name. + +## Arguments + +- `value` - string representing the content name, the wildcard character `*` can be used for partial search + +## Example + +### PHP + +``` php +$query->query = new Criterion\ContentName('*phone'); +``` + +### REST API + +=== "XML" + + ```xml + + + *phone + + + ``` + +=== "JSON" + + ```json + "Query": { + "Filter": { + "ContentNameCriterion": "*phone" + } + } + ``` \ No newline at end of file diff --git a/docs/search/criteria_reference/search_criteria_reference.md b/docs/search/criteria_reference/search_criteria_reference.md index c524a87e8b..43326db78e 100644 --- a/docs/search/criteria_reference/search_criteria_reference.md +++ b/docs/search/criteria_reference/search_criteria_reference.md @@ -25,6 +25,7 @@ Due to this storage limitation, searching content using the Country Field Type o |-----|-----|-----|-----|-----| |[Ancestor](ancestor_criterion.md)|Whether the content item is an ancestor of the provided Location|✔ |✔ |✔ | |[ContentId](contentid_criterion.md)|Content item's ID|✔ |✔ |✔ | +|[ContentName](contentname_criterion.md)|Content item's name|✔ |✔ |✔ | |[ContentTypeGroupId](contenttypegroupid_criterion.md)|ID of the content item's content type group|✔ |✔ |✔ | |[ContentTypeId](contenttypeid_criterion.md)|ID of the content item's content type|✔ |✔ |✔ | |[ContentTypeIdentifier](contenttypeidentifier_criterion.md)|Identifier of the content item's content type|✔ |✔ |✔ | diff --git a/mkdocs.yml b/mkdocs.yml index ebab47e35b..d283ce4ae1 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -475,6 +475,7 @@ nav: - Search Criteria reference: search/criteria_reference/search_criteria_reference.md - Ancestor: search/criteria_reference/ancestor_criterion.md - ContentId: search/criteria_reference/contentid_criterion.md + - ContentName: search/criteria_reference/contentname_criterion.md - ContentTypeGroupId: search/criteria_reference/contenttypegroupid_criterion.md - ContentTypeId: search/criteria_reference/contenttypeid_criterion.md - ContentTypeIdentifier: search/criteria_reference/contenttypeidentifier_criterion.md