Enhance search doc

[adriendupuis]

Question	Answer
JIRA Ticket
Versions
Edition

• 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.
    • 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 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]

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@134:``` php hl_lines="17" docs/search/search_api.md@135:// ... docs/search/search_api.md@136:[[= include_file('code_samples/api/public_php_api/src/Command/FilterLocationCommand.php', 4, 9) =]]// ... docs/search/search_api.md@137:[[= include_file('code_samples/api/public_php_api/src/Command/FilterLocationCommand.php', 32, 52) =]] docs/search/search_api.md@138:``` 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@134:``` php hl_lines="17" docs/search/search_api.md@135:// ... docs/search/search_api.md@136:[[= include_file('code_samples/api/public_php_api/src/Command/FilterLocationCommand.php', 4, 9) =]]// ... docs/search/search_api.md@137:[[= include_file('code_samples/api/public_php_api/src/Command/FilterLocationCommand.php', 32, 52) =]] docs/search/search_api.md@138:``` 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