\FAA\InterfacesSearchPlugin

Summary

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

Methods

RegisterHooks()

RegisterHooks(): array

Register system hooks

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

Returns

array —

A list of hooks to register

SetupTemplate()

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

Get and set the plugin setup template form

Parameters

$data

Returns

\FAA\Obj\Result

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