From 624e5519d92c2eddff97bb65704ec14f8eecbd77 Mon Sep 17 00:00:00 2001 From: julitafalcondusza Date: Mon, 18 Nov 2024 13:36:56 +0100 Subject: [PATCH 1/5] IsBookmarked criterion added --- .../isbookmarked_criterion.md | 33 +++++++++++++++++++ .../search_criteria_reference.md | 1 + mkdocs.yml | 1 + 3 files changed, 35 insertions(+) create mode 100644 docs/search/criteria_reference/isbookmarked_criterion.md diff --git a/docs/search/criteria_reference/isbookmarked_criterion.md b/docs/search/criteria_reference/isbookmarked_criterion.md new file mode 100644 index 0000000000..afe560b7cb --- /dev/null +++ b/docs/search/criteria_reference/isbookmarked_criterion.md @@ -0,0 +1,33 @@ +--- +description: IsBookmarked Search Criterion +--- + +# IsBookmarked Criterion + +The [`IsBookmarked` Search Criterion](../../api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Values-Content-Query-Criterion-Location-IsBookmarked.html) +searches for location based on whether it's bookmarked or not. + +This Criterion is available only for location Search. +It works with current user reference. + +## Arguments + +- `value` - bool representing whether to search for bookmarked location (default `true`) or not bookmarked location (`false`) + +## Example + +### PHP + +``` php +filter = new IsBookmarked(); + +/** @var \Ibexa\Contracts\Core\Repository\SearchService $searchService */ + +$results = $searchService->findLocations($query); +``` diff --git a/docs/search/criteria_reference/search_criteria_reference.md b/docs/search/criteria_reference/search_criteria_reference.md index 43326db78e..7d779d3425 100644 --- a/docs/search/criteria_reference/search_criteria_reference.md +++ b/docs/search/criteria_reference/search_criteria_reference.md @@ -42,6 +42,7 @@ Due to this storage limitation, searching content using the Country Field Type o |[ImageMimeType](imagemimetype_criterion.md)|Image type|✔|✔|| |[ImageOrientation](imageorientation_criterion.md)|Image orientation|✔|✔|| |[ImageWidth](imagewidth_criterion.md)|Image width in pixels|✔|✔|| +|[IsBookmarked](isbookmarked_criterion.md)|Whether a location is bookmarked or not| |✔ |✔ | |[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|✔ |✔ | | |[IsMainLocation](ismainlocation_criterion.md)|Whether a Location is the main Location of a content item| |✔ |✔ | diff --git a/mkdocs.yml b/mkdocs.yml index d507c67a2a..fae1283374 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -499,6 +499,7 @@ nav: - ImageMimeType: search/criteria_reference/imagemimetype_criterion.md - ImageOrientation: search/criteria_reference/imageorientation_criterion.md - ImageWidth: search/criteria_reference/imagewidth_criterion.md + - IsBookmarked: search/criteria_reference/isbookmarked_criterion.md - IsCurrencyEnabled: search/criteria_reference/iscurrencyenabled_criterion.md - IsFieldEmpty: search/criteria_reference/isfieldempty_criterion.md - IsMainLocation: search/criteria_reference/ismainlocation_criterion.md From ff203f17ee51090654a6f39e65df94cb0a7ec9e9 Mon Sep 17 00:00:00 2001 From: julitafalcondusza Date: Mon, 18 Nov 2024 13:50:41 +0100 Subject: [PATCH 2/5] code moved to code_samples --- .../search/location/isbookmarked_criterion.php | 9 +++++++++ .../criteria_reference/isbookmarked_criterion.md | 12 +----------- 2 files changed, 10 insertions(+), 11 deletions(-) create mode 100644 code_samples/search/location/isbookmarked_criterion.php diff --git a/code_samples/search/location/isbookmarked_criterion.php b/code_samples/search/location/isbookmarked_criterion.php new file mode 100644 index 0000000000..3438d45ca1 --- /dev/null +++ b/code_samples/search/location/isbookmarked_criterion.php @@ -0,0 +1,9 @@ +filter = new IsBookmarked(); +/** @var \Ibexa\Contracts\Core\Repository\SearchService $searchService */ +$results = $searchService->findLocations($query); \ No newline at end of file diff --git a/docs/search/criteria_reference/isbookmarked_criterion.md b/docs/search/criteria_reference/isbookmarked_criterion.md index afe560b7cb..9d5a44e0a8 100644 --- a/docs/search/criteria_reference/isbookmarked_criterion.md +++ b/docs/search/criteria_reference/isbookmarked_criterion.md @@ -19,15 +19,5 @@ It works with current user reference. ### PHP ``` php -filter = new IsBookmarked(); - -/** @var \Ibexa\Contracts\Core\Repository\SearchService $searchService */ - -$results = $searchService->findLocations($query); +[[= include_file('code_samples/search/location/isbookmarked_criterion.php') =]] ``` From 4212eb5df05f143ebe561086364d09d8164c4b9e Mon Sep 17 00:00:00 2001 From: julitafalcondusza Date: Mon, 18 Nov 2024 12:57:53 +0000 Subject: [PATCH 3/5] PHP CS Fixes --- code_samples/search/location/isbookmarked_criterion.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/code_samples/search/location/isbookmarked_criterion.php b/code_samples/search/location/isbookmarked_criterion.php index 3438d45ca1..c61bf951b1 100644 --- a/code_samples/search/location/isbookmarked_criterion.php +++ b/code_samples/search/location/isbookmarked_criterion.php @@ -6,4 +6,4 @@ $query = new LocationQuery(); $query->filter = new IsBookmarked(); /** @var \Ibexa\Contracts\Core\Repository\SearchService $searchService */ -$results = $searchService->findLocations($query); \ No newline at end of file +$results = $searchService->findLocations($query); From 502d2fa6dd9fc2eff42a6cb1c851cfd873014aa1 Mon Sep 17 00:00:00 2001 From: julitafalcondusza Date: Thu, 21 Nov 2024 13:02:20 +0100 Subject: [PATCH 4/5] REST API examples added --- .../isbookmarked_criterion.md | 22 +++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/docs/search/criteria_reference/isbookmarked_criterion.md b/docs/search/criteria_reference/isbookmarked_criterion.md index 9d5a44e0a8..a87bf9da75 100644 --- a/docs/search/criteria_reference/isbookmarked_criterion.md +++ b/docs/search/criteria_reference/isbookmarked_criterion.md @@ -21,3 +21,25 @@ It works with current user reference. ``` php [[= include_file('code_samples/search/location/isbookmarked_criterion.php') =]] ``` + +### REST API + +=== "XML" + + ```xml + + + true + + + ``` + +=== "JSON" + + ```json + "Query": { + "Filter": { + "IsBookmarkedCriterion": true + } + } + ``` From c492e62c1e1c8743a5ebb164a74c471f8a96558e Mon Sep 17 00:00:00 2001 From: julitafalcondusza Date: Fri, 22 Nov 2024 12:47:07 +0100 Subject: [PATCH 5/5] Fixes after review --- docs/search/criteria_reference/isbookmarked_criterion.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/search/criteria_reference/isbookmarked_criterion.md b/docs/search/criteria_reference/isbookmarked_criterion.md index a87bf9da75..049232deca 100644 --- a/docs/search/criteria_reference/isbookmarked_criterion.md +++ b/docs/search/criteria_reference/isbookmarked_criterion.md @@ -6,9 +6,9 @@ description: IsBookmarked Search Criterion The [`IsBookmarked` Search Criterion](../../api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-Values-Content-Query-Criterion-Location-IsBookmarked.html) searches for location based on whether it's bookmarked or not. +It works with current user reference. This Criterion is available only for location Search. -It works with current user reference. ## Arguments @@ -19,7 +19,7 @@ It works with current user reference. ### PHP ``` php -[[= include_file('code_samples/search/location/isbookmarked_criterion.php') =]] +[[= include_file('code_samples/search/location/isbookmarked_criterion.php', 2) =]] ``` ### REST API