Enhance search doc: TrashService references, LocationList::getTotalCount()

[adriendupuis]

Question	Answer
JIRA Ticket	N/A
Versions	4.6, master
Edition	All

⚠️ Wait for ibexa/core#486 being included in a release.

• Repository filtering: Use LocationList::getTotalCount() instead of LocationList::$totalCount (see this getter addition circa v4.2.3)
  • https://doc.ibexa.co/en/latest/search/search_api/#repository-filtering
  • https://ez-systems-developer-documentation--2540.com.readthedocs.build/en/2540/search/search_api/#repository-filtering
• Most of TrashService::findTrashItems criteria and sort clauses are to be also used with SearchService and Repository Filtering.
  • Rework trash search reference's intro. Add ContentName. Quote DateMetadata::TRASHED.
    • https://doc.ibexa.co/en/latest/search/search_in_trash_reference/
    • https://ez-systems-developer-documentation--2540.com.readthedocs.build/en/2540/search/search_in_trash_reference/
  • Add a "Trash" column to search criteria reference table to highlight which are shared.
    • https://doc.ibexa.co/en/latest/search/criteria_reference/search_criteria_reference/#search-criteria
    • https://ez-systems-developer-documentation--2540.com.readthedocs.build/en/2540/search/criteria_reference/search_criteria_reference/#search-criteria
  • Idem with sort clauses reference
    • https://doc.ibexa.co/en/latest/search/sort_clause_reference/sort_clause_reference/#sort-clauses
    • https://ez-systems-developer-documentation--2540.com.readthedocs.build/en/2540/search/sort_clause_reference/sort_clause_reference/#sort-clauses

Checklist

• Text renders correctly
• Text has been checked with vale
• Description metadata is up to date
• Redirects cover removed/moved pages
• Code samples are working
• PHP code samples have been fixed with PHP CS fixer
• Added link to this PR in relevant JIRA ticket or code PR

[github-actions]

Preview of modified Markdown:

• docs/search/criteria_reference/search_criteria_reference.md
• docs/search/search_api.md
• docs/search/search_in_trash_reference.md
• docs/search/sort_clause_reference/sort_clause_reference.md

[barw4]

Trash also uses the ContentName search criterion.

[adriendupuis]

Trash also uses the ContentName search criterion.

@barw4 Thank you for pointing me this one and showing me its handler tag.

Added in bc136a1

I missed it because it wasn't marked a trash criterion. I propose to mark it in ibexa/core#486

[mnocon]

Thank you for covering this!

I think the ContentName criterion is missing here: https://ez-systems-developer-documentation--2540.com.readthedocs.build/en/2540/search/search_in_trash_reference/ , could you please check?

Optional, something we can think about in the future:

I like the addition of the Trash column for criterions and sort clauses, it's much more readable this way - the question for me is if we still need to list them explicitly in the dedicated Trash reference (maybe just linking to the expanded tables would be enough and would make it easier to maintain)

[github-actions]

code_samples/ change report

Before (on target branch)	After (in current PR)
code_samples/api/public_php_api/src/Command/FilterLocationCommand.php docs/search/search_api.md@128:``` php hl_lines="17" docs/search/search_api.md@129:// ... docs/search/search_api.md@130:[[= include_file('code_samples/api/public_php_api/src/Command/FilterLocationCommand.php', 4, 9) =]]// ... docs/search/search_api.md@131:[[= include_file('code_samples/api/public_php_api/src/Command/FilterLocationCommand.php', 32, 52) =]] docs/search/search_api.md@132:``` 001⫶// ... 002⫶use Ibexa\Contracts\Core\Repository\LocationService; 003⫶use Ibexa\Contracts\Core\Repository\Values\Content\Query; 004⫶use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion; 005⫶use Ibexa\Contracts\Core\Repository\Values\Content\Query\SortClause; 006⫶use Ibexa\Contracts\Core\Repository\Values\Filter\Filter; 007⫶// ... 008⫶ protected function execute(InputInterface $input, OutputInterface $output): int 009⫶ { 010⫶ $parentLocationId = (int)$input->getArgument('parentLocationId'); 011⫶ 012⫶ $filter = new Filter(); 013⫶ $filter 014⫶ ->withCriterion(new Criterion\ParentLocationId($parentLocationId)) 015⫶ ->withSortClause(new SortClause\ContentName(Query::SORT_DESC)); 016⫶ 017❇️ $result = $this->locationService->find($filter, []); 018⫶	code_samples/api/public_php_api/src/Command/FilterLocationCommand.php docs/search/search_api.md@128:``` php hl_lines="17" docs/search/search_api.md@129:// ... docs/search/search_api.md@130:[[= include_file('code_samples/api/public_php_api/src/Command/FilterLocationCommand.php', 4, 9) =]]// ... docs/search/search_api.md@131:[[= include_file('code_samples/api/public_php_api/src/Command/FilterLocationCommand.php', 32, 52) =]] docs/search/search_api.md@132:``` 001⫶// ... 002⫶use Ibexa\Contracts\Core\Repository\LocationService; 003⫶use Ibexa\Contracts\Core\Repository\Values\Content\Query; 004⫶use Ibexa\Contracts\Core\Repository\Values\Content\Query\Criterion; 005⫶use Ibexa\Contracts\Core\Repository\Values\Content\Query\SortClause; 006⫶use Ibexa\Contracts\Core\Repository\Values\Filter\Filter; 007⫶// ... 008⫶ protected function execute(InputInterface $input, OutputInterface $output): int 009⫶ { 010⫶ $parentLocationId = (int)$input->getArgument('parentLocationId'); 011⫶ 012⫶ $filter = new Filter(); 013⫶ $filter 014⫶ ->withCriterion(new Criterion\ParentLocationId($parentLocationId)) 015⫶ ->withSortClause(new SortClause\ContentName(Query::SORT_DESC)); 016⫶ 017❇️ $result = $this->locationService->find($filter, []); 018⫶
019⫶ $output->writeln('Found ' . $result->totalCount . ' items');	019⫶ $output->writeln('Found ' . $result->getTotalCount() . ' items');
020⫶ 021⫶ foreach ($result as $content) { 022⫶ $output->writeln($content->getContent()->getName()); 023⫶ } 024⫶ 025⫶ return self::SUCCESS; 026⫶ } 027⫶}	020⫶ 021⫶ foreach ($result as $content) { 022⫶ $output->writeln($content->getContent()->getName()); 023⫶ } 024⫶ 025⫶ return self::SUCCESS; 026⫶ } 027⫶}

Download colorized diff

[mnocon]

Thank you!