IBX-6649: Added support for spell checking

[adamwojs]

Question	Answer
JIRA issue	IBX-6649
Type	feature
Target Ibexa version	v4.6
BC breaks	no

Introduction

Added API to execute spell checking on search phrase and suggest potential alternatives for the user. Typical use case for this API is is "Did you mean X ?" functionality:

Similar feature implementation in Ibexa DXP:

• IBX-6649: Added support for spell checking search#32
• IBX-6649: Added support for spell checking admin-ui#923

Usage example

// "Ibexa Platfrom" is user input with typo
$input = "Ibexa Platfrom";

$query = new Query();
$query->query = new FullText($input);
$query->spellcheck = new Spellcheck($input);

$results = $searchService->findContent($query);

if ($results->spellcheck->isIncorrect()) {
    $suggestion = $results->getSpellcheck()->getQuery();

    // Display link with suggested search phrase 
} 

API changes summary

• Introduced \Ibexa\Contracts\Core\Repository\Values\Content\Query\Spellcheck and \Ibexa\Contracts\Core\Repository\Values\Content\Search\SpellcheckResult classes
• Deprecated \Ibexa\Contracts\Core\Repository\Values\Content\Search\SearchResult::$spellSuggestion property.
• Changed \Ibexa\Contracts\Core\Repository\Values\Content\Query::$spellcheck property type from bool to \Ibexa\Contracts\Core\Repository\Values\Content\Query\Spellcheck|null.

Supported search engines

Spellcheck API is supported by solr and elasticsearch search engines. However suggestions might be differ between search engines and highly depends on search engine settings. More details in search engine specific PRs:

• IBX-6649: Added support for spell checking solr#52
• https://github.com/ibexa/elasticsearch/pull/28

Checklist:

• Provided PR description.
• Tested the solution manually.
• Provided automated test coverage.
• Checked that target branch is set correctly (main for features, the oldest supported for bugs).
• Ran PHP CS Fixer for new PHP code (use $ composer fix-cs).
• Asked for a review (ping for example @ibexa/php-dev for back-end changes and/or @ibexa/javascript-dev for front-end changes).

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
1 Code Smell

No Coverage information
0.0% Duplication

[sonarcloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication