\FAA\Plugin\TaskSearchHandler

Summary

Methods
Properties
Constants
SetupTemplate()
RegisterHooks()
OnIndex()
OnNewIndex()
OnSyncronize()
OnAddOrUpdateContent()
OnRenameFolder()
OnDeleteContent()
DoSearch()
OnRegisterWidgetIncludes()
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.

Returns

array —

The list of registered hooks

OnIndex()

OnIndex(  $reference) 

Parameters

$reference

CronHookArgument

OnNewIndex()

OnNewIndex(  $reference) 

Parameters

$reference

OnSyncronize()

OnSyncronize(  $reference) 

Parameters

$reference

CronHookArgument

OnAddOrUpdateContent()

OnAddOrUpdateContent(  $reference) 

Parameters

$reference

HookArgument

OnRenameFolder()

OnRenameFolder(  $reference) 

Handle rename operations

Parameters

$reference

HookArgument

OnDeleteContent()

OnDeleteContent(  $reference) 

Parameters

$reference

HookArgument

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

OnRegisterWidgetIncludes()

OnRegisterWidgetIncludes(  $param) 

Parameters

$param

BuildEntry()

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

Convert the response to search task object

Parameters

\stdClass $doc

The solr search result

string $language

The target language of the search request

array|null $extra

Additional fields

Returns

\FAA\Obj\Search\Response\Task

The search task object