\FAA\Plugin\BasketSearchHandler

Summary

Methods
Properties
Constants
SetupTemplate()
RegisterHooks()
OnIndex()
OnNewIndex()
OnSyncronize()
OnAddOrUpdateContent()
OnDeleteContent()
DoSearch()
BuildEntry()
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. These are mainly used to manage the basket search with update interfaces

Returns

array —

The hooks to register

OnIndex()

OnIndex(  $reference)

Parameters

$reference

OnNewIndex()

OnNewIndex(  $reference)

Parameters

$reference

OnSyncronize()

OnSyncronize(  $reference)

Parameters

$reference

OnAddOrUpdateContent()

OnAddOrUpdateContent(  $reference)

Parameters

$reference

OnDeleteContent()

OnDeleteContent(  $reference)

Parameters

$reference

DoSearch()

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

Execute the search in the list of baskets

Parameters

string $language

The language to search in

array $payload

The search request

Returns

\FAA\Obj\Result

BuildEntry()

BuildEntry(\stdClass  $doc,string  $language,array|null  $extra = null): \FAA\Obj\Search\Response\Basket

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

\FAA\Obj\Search\Response\Basket

A search basket object