\FAA\Plugin\ResourceSearchHandler

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(null  $data = null): \FAA\Obj\Result

Getter and setter for config data

When no data is given it will read otherwise write. This method is cached by setup handler

Parameters

null

$data

Returns

\FAA\Obj\Result

RegisterHooks()

RegisterHooks(): array

Register system hooks

Returns

array —

The list of registered hooks

OnIndex()

OnIndex(\FAA\Obj\Sys\HookArgument  $reference)

Parameters

\FAA\Obj\Sys\HookArgument

$reference

A hook argument

OnNewIndex()

OnNewIndex(\FAA\Obj\Sys\HookArgument  $reference)

Parameters

\FAA\Obj\Sys\HookArgument

$reference

A hook argument

OnSyncronize()

OnSyncronize(\FAA\Obj\Sys\HookArgument  $reference)

Parameters

\FAA\Obj\Sys\HookArgument

$reference

A hook argument

OnAddOrUpdateContent()

OnAddOrUpdateContent(\FAA\Obj\Sys\HookArgument  $reference)

Parameters

\FAA\Obj\Sys\HookArgument

$reference

A hook argument

OnDeleteContent()

OnDeleteContent(\FAA\Obj\Sys\HookArgument  $reference)

Parameters

\FAA\Obj\Sys\HookArgument

$reference

A hook argument

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

BuildEntry()

BuildEntry(\stdClass  $doc,\FAA\Plugin\ResourceSearch\?string  $language,null  $extra = null): Resource|\stdClass

Build a search response entry for resources

Parameters

\stdClass	$doc	The search response
\FAA\Plugin\ResourceSearch\?string	$language	The request language
null	$extra	Additional fields

Returns

Resource|\stdClass