Heratio Framework API Reference

BrowseSearchEnhancer
in package

Browse Search Enhancer

Hooks into AtoM's browse action to enhance search with synonyms. Call this from a modified browseAction or via event/filter.

Table of Contents

Methods

applyToQuery()  : BoolQuery
Apply synonym expansion to an Elastica BoolQuery
enhance()  : array<string|int, mixed>
Enhance a search query and return expanded terms
getLastEnhancement()  : array<string|int, mixed>|null
Get the last enhancement result (for display in UI)
isEnabled()  : bool
Check if enhanced search is enabled
logSearch()  : void
Log a search query

Methods

applyToQuery()

Apply synonym expansion to an Elastica BoolQuery

public static applyToQuery(BoolQuery $boolQuery, string $query) : BoolQuery
Parameters
$boolQuery : BoolQuery
$query : string
Return values
BoolQuery

Modified query

enhance()

Enhance a search query and return expanded terms

public static enhance(string $query) : array<string|int, mixed>
Parameters
$query : string

The user's search query

Return values
array<string|int, mixed>

Enhancement data including synonyms

getLastEnhancement()

Get the last enhancement result (for display in UI)

public static getLastEnhancement() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

isEnabled()

Check if enhanced search is enabled

public static isEnabled() : bool
Return values
bool

logSearch()

Log a search query

public static logSearch(string $query, int $resultCount) : void
Parameters
$query : string
$resultCount : int

        
On this page

Search results