IBX-6878: Customize BO search suggestions

[adriendupuis]

Question	Answer
JIRA Ticket	IBX-6878
Versions	4.6
Edition	All

How to customize Back Office search bar suggestions

• Config
• Suggestion source addition
• Suggestion source replacement

Install and test "Add custom suggestion source" example:

cp -R $DOC_DIR/code_samples/back_office/search/* $DXP_DIR/
cd $DXP_DIR/
tail -n +2 config/append_to_services.yaml >> config/services.yaml && rm config/append_to_services.yaml
cat append_to_webpack.config.js >> webpack.config.js && rm append_to_webpack.config.js
composer run post-install-cmd

Maybe add some more contents if you're on clean install:

composer config minimum-stability dev
composer require ibexa/test-fixtures
php bin/console ibexa:test-fixtures:setup

• Create a product named "Platform".
• In the same browser to have the admin session cookie, open something like http://localhost/admin/suggestion?query=platform where your Platform product should be fist
• Type 'platform" in the BO search bar, your product should be suggested first, before content (page and folder) from clean install.

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

[mnocon]

Looks good! Just a couple of small suggestions

[mnocon]

Is it recommended to set the SiteAccess parameters directly?

I always thought that the ibexa.system.<scope> configuration is preferred (in this case: https://github.com/ibexa/search/blob/main/src/bundle/DependencyInjection/Configuration/Parser/SiteAccessAware/SuggestionParser.php#L20-L29)

[adriendupuis]

Modifications made above and below in 3d9e332.
@mnocon Is it solving your concern?

[adriendupuis]

Side note:

We may need to add something to https://doc.ibexa.co/en/latest/administration/configuration/dynamic_configuration/

The example starts with something that could lead to bad practice:

parameters:
    # Internal configuration
    ibexa.site_access.config.default.content.default_ttl: 60
    ibexa.site_access.config.site_group.content.default_ttl: 3600

[mnocon]

Yes, I think for our configuration you can always use the SiteAccess-aware configuration - and settings the parameters directly is not recommended (might be needed by partners for something custom, if they don't want to provide the configuration 🤔 )