\FAA\Plugin\BotOptSearchHandler

Summary

Methods
Properties
Constants
SetupTemplate()
RegisterHooks()
OnClearAllCache()
BuildEntry()
DoSearch()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

SetupTemplate()

SetupTemplate(array  $data = null): \FAA\Obj\Result

Setup getter and setter

The setter is just an interface and not active

Parameters

array $data

New configuration values

Returns

\FAA\Obj\Result —

The template fetch result

RegisterHooks()

RegisterHooks(): array

register system hooks Register a set of handler functions to be called in certain positions.

Returns

array —

A array with hooks

OnClearAllCache()

OnClearAllCache(  $reference)

Parameters

$reference

BuildEntry()

BuildEntry(\stdClass  $doc,string  $language,array|null  $extra = null): \stdClass

Build entry Convert the search result to frontend object row

Parameters

\stdClass $doc

The search response

string $language

The request language

array|null $extra

Additional fields

Returns

\stdClass —

A result object

DoSearch()

DoSearch(string  $language,array  $payload): \FAA\Obj\Result

Do search Execute the search by given arguments

Parameters

string $language

The language to search in

array $payload

The search request

Returns

\FAA\Obj\Result —

A system result