Search Context - boxalino/rtux-integration-magento2 GitHub Wiki

Before you continue, make sure the required integration steps have been completed.

The search context is about replacing search view/response with API response blocks. The Boxalino widget is search. The rest of the properties are inherited from the request & Magento2 configurations (hitCount, sorting, facets etc)

The content of the response depends 100% on your design and layout blocks desired.

Before a feature test, the layout blocks & narrative layout must be defined in Boxalino Intelligence admin.

The Layout Blocks JSON & Narratives JSON from this page can be used as base.

If there is no narrative assigned to the choice/widget requested, the response will be empty.

Integration description

The Layout Blocks JSON & Narrative Layout JSON sample is minimalistic. Following this integration, the page title ( public function getSearchQueryText() and the main-content search.result is being replaced by the Narrative API. These guidelines do not update the default Magento2 catalogsearch_result_index layout

Due to the listing context, the following elements are defined as layout blocks and used in the API layout. Templates and block types have been provided as well but the decision to re-use them is up to the integrator:

toolbar
pagination
sorting

More documentation on the provided elements is available in the framework wiki.

The provided JSON samples for the Narrative layout and the Layout blocks must be imported in Boxalino Intelligence Admin . Make sure to use your project namespace for templates or other properties definitions.

The Search strategy

During a search request, there are 3 available scenarios for a response:

there are matches for the search query (or a corrected search query) - a list of products & facets to be displayed
there are sub-phrases matches - multiple lists of products to be displayed (per each sub-query match)
there are no matches - a list of "noresults" recommendations is returned

Based on the described branches, the search layout is a conditional layout. In the integration guidelines all 3 scenarios are part of the narrative layout.

Steps

In order to enable Boxalino search, the following steps are needed:

1. Implement the Boxalino RTUX API ContextInterface

In the most basic integration (ex: when extending from the provided base ContextAbstract ) - only 3 functions are left to be implemented in order to set:

the products visibility (as filter values)
the products category (as filter - depends on the context)
the return fields (which can be set via layout XML as well)

Some of the properties to be set/enabled are the ones needed by the SearchRequestDefinitionInterface:

Subphrases count (default:1)
Subphrases products count

The filters list can be changed by rewriting the addFilters(RequestInterface $request) function.

FYI: the SearchRequestDefinitionInterface must be defined on the context due to the nature of the context: search.

2. Create the Search/Result block

To keep things simple, the default Magento2 Search Result block is used as a parent in order to also ensure a safe fallback strategy. Due to that, some of the functions had to be rewritten to validate the fallback or to allow you re-use the default template (comments available on the target functions)

In order to replace the content of "search.result", the template is being updated to the default API block template which will render the response content.

This is a recommendation because the search narrative layout strategy is for 3 scenarios: some results, subphrases and no results - which is not supported by the default Magento_CatalogSearch::result.phtml template

3. Update the DI

3.1 Search Redirects

In order to integrate the API redirect values, the controller must be rewritten:

Create the Result/Index controller

Extend for your main catalogsearch_result_index.xml controller; if there are custom dependencies in your project - take those into account

Declare the preference in di.xml

The redirect values are configured in Intelligence Admin by the client/customer. https://boxalino.atlassian.net/wiki/spaces/BPKB/pages/354943221/Search+Redirects

Declare the preference in frontend/di.xml for LayeredNavigation

4. Follow the navigation facets integration

5. (Optional) Follow the top facets integration

6. Create facets (or load in the Intelligence Admin);

In Intelligence Admin check the "Force Include" option on the facet. This will send it as part of the API response.

Layout Blocks JSON

Narrative Layout JSON