Skip to content

Commit 13646d5

Browse files
adriendupuisadriendupuis
authored
Enhance search doc: TrashService references, LocationList::getTotalCount() (#2540)
* Use LocationList::getTotalCount() instead of LocationList::$totalCount * Search criteria and sort references: Add a "Trash" column
1 parent 6aaa639 commit 13646d5

File tree

5 files changed

+84
-81
lines changed

5 files changed

+84
-81
lines changed

‎code_samples/api/public_php_api/src/Command/FilterLocationCommand.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
4141

4242
$result = $this->locationService->find($filter, []);
4343

44-
$output->writeln('Found ' . $result->totalCount . ' items');
44+
$output->writeln('Found ' . $result->getTotalCount() . ' items');
4545

4646
foreach ($result as $content) {
4747
$output->writeln($content->getContent()->getName());

‎docs/search/criteria_reference/search_criteria_reference.md‎

Lines changed: 55 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -20,64 +20,64 @@ Due to this storage limitation, searching content using the Country field type o
2020

2121
## Search Criteria
2222

23-
|Search Criterion|Search based on|Content Search |Location Search |Filtering |
24-
|-----|-----|-----|-----|-----|
25-
|[Ancestor](ancestor_criterion.md)|Whether the content item is an ancestor of the provided location|✔ |✔ |✔ |
26-
|[ContentId](contentid_criterion.md)|Content item's ID|✔ |✔ |✔ |
27-
|[ContentName](contentname_criterion.md)|Content item's name|✔ |✔ |✔ |
28-
|[ContentTypeGroupId](contenttypegroupid_criterion.md)|ID of the content item's content type group|✔ |✔ |✔ |
29-
|[ContentTypeId](contenttypeid_criterion.md)|ID of the content item's content type|✔ |✔ |✔ |
30-
|[ContentTypeIdentifier](contenttypeidentifier_criterion.md)|Identifier of the content item's content type|✔ |✔ |✔ |
31-
|[CurrencyCodeCriterion](currencycode_criterion.md)|Currency code|✔ |✔ |✔ |
32-
|[DateMetadata](datemetadata_criterion.md)|The date when content was created or last modified|✔ |✔ |✔ |
33-
|[Depth](depth_criterion.md)|Location depth in the content tree| |✔ |✔ |
34-
|[Field](field_criterion.md)|Content of one of content item's fields|✔ |✔ | |
35-
|[FieldRelation](fieldrelation_criterion.md)|Content items the content in question has Relations to|✔ |✔ | |
36-
|[FullText](fulltext_criterion.md)|Full text content of a content item's fields|✔ |✔ | |
37-
|[Image](image_criterion.md)|Image by specified image attributes|✔|✔||
38-
|[ImageDimensions](imagedimensions_criterion.md)|Image dimensions: height and width|✔|✔||
39-
|[ImageFileSize](imagefilesize_criterion.md)|Image size in MB|✔|✔||
40-
|[ImageHeight](imageheight_criterion.md)|Image height in pixels|✔|✔||
41-
|[ImageMimeType](imagemimetype_criterion.md)|Image type|✔|✔||
42-
|[ImageOrientation](imageorientation_criterion.md)|Image orientation|✔|✔||
43-
|[ImageWidth](imagewidth_criterion.md)|Image width in pixels|✔|✔||
44-
|[IsBookmarked](isbookmarked_criterion.md)|Whether a location is bookmarked or not| |✔ |✔ |
45-
|[IsCurrencyEnabledCriterion](iscurrencyenabled_criterion.md)|Whether a specified currency is enabled in the system| | | |
46-
|[IsFieldEmpty](isfieldempty_criterion.md)|Whether a specified field of a content item is empty or not|✔ |✔ | |
47-
|[IsMainLocation](ismainlocation_criterion.md)|Whether a location is the main location of a content item| |✔ |✔ |
48-
|[IsProductBased](isproductbased_criterion.md)|Whether content represents a product|✔ |✔ |✔ |
49-
|[IsUserBased](isuserbased_criterion.md)|Whether content represents a User account|✔ |✔ |✔ |
50-
|[IsUserEnabled](isuserenabled_criterion.md)|Whether a User account is enabled|✔ |✔ |✔ |
51-
|[LanguageCode](languagecode_criterion.md)|Whether a content item is translated into the selected language|✔ |✔ |✔ |
52-
|[LocationId](locationid_criterion.md)|Location ID|✔ |✔ |✔ |
53-
|[LocationRemoteId](locationremoteid_criterion.md)|Location remote ID|✔ |✔ |✔ |
54-
|[MapLocationDistance](maplocationdistance_criterion.md)|Distance between the location contained in a MapLocation field and the provided coordinates|✔ |✔ | |
55-
|[MatchAll](matchall_criterion.md)|Returns all search results|✔ |✔ |✔ |
56-
|[MatchNone](matchnone_criterion.md)|Returns no search results|✔ |✔ |✔ |
57-
|[ObjectStateId](objectstateid_criterion.md)|Object state ID|✔ |✔ |✔ |
58-
|[ObjectStateIdentifier](objectstateidentifier_criterion.md)|Object state Identifier|✔ |✔ |✔ |
59-
|[ParentLocationId](parentlocationid_criterion.md)|Location ID of a content item's parent|✔ |✔ |✔ |
60-
|[ParentLocationRemoteId](parentlocationremoteId_criterion.md)|Location remote ID of a content item's parent|✔ |✔ |
61-
|[Priority](priority_criterion.md)|Location priority| |✔ |✔ |
62-
|[RemoteId](remoteid_criterion.md)|Remote content ID|✔ |✔ |✔ |
63-
|[SectionId](sectionid_criterion.md)|ID of the Section content is assigned to|✔ |✔ |✔ |
64-
|[SectionIdentifier](sectionidentifier_criterion.md)|Identifier of the Section content is assigned to|✔ |✔ |✔ |
65-
|[Sibling](sibling_criterion.md)|Locations that are children of the same parent|✔ |✔ |✔ |
66-
|[Subtree](subtree_criterion.md)|Location subtree|✔ |✔ |✔ |
67-
|[TaxonomyEntryId](taxonomy_entry_id.md)|Content tagged with Entry ID|✔ |✔ |✔ |
68-
|[UserEmail](useremail_criterion.md)|Email address of a User account|✔ |✔ |✔ |
69-
|[UserId](userid_criterion.md)|User ID|✔ |✔ |✔ |
70-
|[UserLogin](userlogin_criterion.md)|User login|✔ |✔ |✔ |
71-
|[UserMetadata](usermetadata_criterion.md)|The creator or modifier of a content item|✔ |✔ |✔ |
72-
|[Visibility](visibility_criterion.md)|Whether the content item is visible or not|✔ |✔ |✔ |
23+
| Search Criterion | Search based on | Content Search | Location Search | Filtering | Trash |
24+
|---------------------------------------------------------------|---------------------------------------------------------------------------------------------|----------------|-----------------|-----------|----------|
25+
| [Ancestor](ancestor_criterion.md) | Whether the content item is an ancestor of the provided location | ✔ | ✔ | ✔ | |
26+
| [ContentId](contentid_criterion.md) | Content item's ID | ✔ | ✔ | ✔ | |
27+
| [ContentName](contentname_criterion.md) | Content item's name | ✔ | ✔ | ✔ | ✔ |
28+
| [ContentTypeGroupId](contenttypegroupid_criterion.md) | ID of the content item's content type group | ✔ | ✔ | ✔ | |
29+
| [ContentTypeId](contenttypeid_criterion.md) | ID of the content item's content type | ✔ | ✔ | ✔ | ✔ |
30+
| [ContentTypeIdentifier](contenttypeidentifier_criterion.md) | Identifier of the content item's content type | ✔ | ✔ | ✔ | |
31+
| [CurrencyCodeCriterion](currencycode_criterion.md) | Currency code | ✔ | ✔ | ✔ | |
32+
| [DateMetadata](datemetadata_criterion.md) | The date when content was created or last modified | ✔ | ✔ | ✔ | ✔ |
33+
| [Depth](depth_criterion.md) | Location depth in the content tree | | ✔ | ✔ | |
34+
| [Field](field_criterion.md) | Content of one of content item's fields | ✔ | ✔ | | |
35+
| [FieldRelation](fieldrelation_criterion.md) | Content items the content in question has Relations to | ✔ | ✔ | | |
36+
| [FullText](fulltext_criterion.md) | Full text content of a content item's fields | ✔ | ✔ | | |
37+
| [Image](image_criterion.md) | Image by specified image attributes | ✔ | ✔ | | |
38+
| [ImageDimensions](imagedimensions_criterion.md) | Image dimensions: height and width | ✔ | ✔ | | |
39+
| [ImageFileSize](imagefilesize_criterion.md) | Image size in MB | ✔ | ✔ | | |
40+
| [ImageHeight](imageheight_criterion.md) | Image height in pixels | ✔ | ✔ | | |
41+
| [ImageMimeType](imagemimetype_criterion.md) | Image type | ✔ | ✔ | | |
42+
| [ImageOrientation](imageorientation_criterion.md) | Image orientation | ✔ | ✔ | | |
43+
| [ImageWidth](imagewidth_criterion.md) | Image width in pixels | ✔ | ✔ | | |
44+
| [IsBookmarked](isbookmarked_criterion.md) | Whether a location is bookmarked or not | | ✔ | ✔ | |
45+
| [IsCurrencyEnabledCriterion](iscurrencyenabled_criterion.md) | Whether a specified currency is enabled in the system | | | | |
46+
| [IsFieldEmpty](isfieldempty_criterion.md) | Whether a specified field of a content item is empty or not | ✔ | ✔ | | |
47+
| [IsMainLocation](ismainlocation_criterion.md) | Whether a location is the main location of a content item | | ✔ | ✔ | |
48+
| [IsProductBased](isproductbased_criterion.md) | Whether content represents a product | ✔ | ✔ | ✔ | |
49+
| [IsUserBased](isuserbased_criterion.md) | Whether content represents a User account | ✔ | ✔ | ✔ | |
50+
| [IsUserEnabled](isuserenabled_criterion.md) | Whether a User account is enabled | ✔ | ✔ | ✔ | |
51+
| [LanguageCode](languagecode_criterion.md) | Whether a content item is translated into the selected language | ✔ | ✔ | ✔ | |
52+
| [LocationId](locationid_criterion.md) | Location ID | ✔ | ✔ | ✔ | |
53+
| [LocationRemoteId](locationremoteid_criterion.md) | Location remote ID | ✔ | ✔ | ✔ | |
54+
| [MapLocationDistance](maplocationdistance_criterion.md) | Distance between the location contained in a MapLocation field and the provided coordinates | ✔ | ✔ | | |
55+
| [MatchAll](matchall_criterion.md) | Returns all search results | ✔ | ✔ | ✔ | ✔ |
56+
| [MatchNone](matchnone_criterion.md) | Returns no search results | ✔ | ✔ | ✔ | ✔ |
57+
| [ObjectStateId](objectstateid_criterion.md) | Object state ID | ✔ | ✔ | ✔ | |
58+
| [ObjectStateIdentifier](objectstateidentifier_criterion.md) | Object state Identifier | ✔ | ✔ | ✔ | |
59+
| [ParentLocationId](parentlocationid_criterion.md) | Location ID of a content item's parent | ✔ | ✔ | ✔ | |
60+
| [ParentLocationRemoteId](parentlocationremoteId_criterion.md) | Location remote ID of a content item's parent | ✔ | ✔ | |
61+
| [Priority](priority_criterion.md) | Location priority | | ✔ | ✔ | |
62+
| [RemoteId](remoteid_criterion.md) | Remote content ID | ✔ | ✔ | ✔ | |
63+
| [SectionId](sectionid_criterion.md) | ID of the Section content is assigned to | ✔ | ✔ | ✔ | ✔ |
64+
| [SectionIdentifier](sectionidentifier_criterion.md) | Identifier of the Section content is assigned to | ✔ | ✔ | ✔ | |
65+
| [Sibling](sibling_criterion.md) | Locations that are children of the same parent | ✔ | ✔ | ✔ | |
66+
| [Subtree](subtree_criterion.md) | Location subtree | ✔ | ✔ | ✔ | |
67+
| [TaxonomyEntryId](taxonomy_entry_id.md) | Content tagged with Entry ID | ✔ | ✔ | ✔ | |
68+
| [UserEmail](useremail_criterion.md) | Email address of a User account | ✔ | ✔ | ✔ | |
69+
| [UserId](userid_criterion.md) | User ID | ✔ | ✔ | ✔ | |
70+
| [UserLogin](userlogin_criterion.md) | User login | ✔ | ✔ | ✔ | |
71+
| [UserMetadata](usermetadata_criterion.md) | The creator or modifier of a content item | ✔ | ✔ | ✔ | ✔ |
72+
| [Visibility](visibility_criterion.md) | Whether the content item is visible or not | ✔ | ✔ | ✔ | |
7373

7474
### Logical operators
7575

7676
All Logical operators are supported by Content and Location Search and
7777
[Repository filtering](search_api.md#repository-filtering).
7878

79-
|Search Criterion|Search based on|
80-
|-----|-----|
81-
|[LogicalAnd](logicaland_criterion.md)|Implements a logical AND Criterion. It matches if ALL of the provided Criteria match.|
82-
|[LogicalNot](logicalnot_criterion.md)|Implements a logical NOT Criterion. It matches if the provided Criterion doesn't match.|
83-
|[LogicalOr](logicalor_criterion.md)|Implements a logical OR Criterion. It matches if at least one of the provided Criteria matches.|
79+
| Search Criterion | Search based on |
80+
|---------------------------------------|-------------------------------------------------------------------------------------------------|
81+
| [LogicalAnd](logicaland_criterion.md) | Implements a logical AND Criterion. It matches if ALL of the provided Criteria match. |
82+
| [LogicalNot](logicalnot_criterion.md) | Implements a logical NOT Criterion. It matches if the provided Criterion doesn't match. |
83+
| [LogicalOr](logicalor_criterion.md) | Implements a logical OR Criterion. It matches if at least one of the provided Criteria matches. |

‎docs/search/search_api.md‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,8 +131,6 @@ The same Filter can be applied to find locations instead of content items, for e
131131
[[= include_file('code_samples/api/public_php_api/src/Command/FilterLocationCommand.php', 32, 52) =]]
132132
```
133133

134-
Notice that the total number of items is retrieved differently for `ContentList` and `LocationList`.
135-
136134
!!! caution
137135

138136
The total count is the total number of matched items, regardless of pagination settings.

‎docs/search/search_in_trash_reference.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,15 @@ page_type: reference
55

66
# Search in trash reference
77

8-
When you [search for content items that are held in trash](search_api.md#searching-in-trash), you can apply only a limited set of Search Criteria and Sort Clauses.
9-
They can be used by `Ibexa\Contracts\Core\Repository\TrashService::findTrashItems` only.
8+
When you [search for content items that are held in trash](search_api.md#searching-in-trash), you can apply only a limited subset of Search Criteria and Sort Clauses
9+
which can be used by [`Ibexa\Contracts\Core\Repository\TrashService::findTrashItems`](../api/php_api/php_api_reference/classes/Ibexa-Contracts-Core-Repository-TrashService.html#method_findTrashItems).
10+
Some sort clauses are exclusive to trash search.
1011

1112
## Search Criteria
1213

14+
- [ContentName](contentname_criterion.md)
1315
- [ContentTypeId](contenttypeid_criterion.md)
14-
- [DateMetadata](datemetadata_criterion.md)
16+
- [DateMetadata](datemetadata_criterion.md) (which can use the additional exclusive target `DateMetadata::TRASHED`)
1517
- [MatchAll](matchall_criterion.md)
1618
- [MatchNone](matchnone_criterion.md)
1719
- [SectionId](sectionid_criterion.md)

0 commit comments

Comments
 (0)