SearchPreprocessor
abstract class SearchPreprocessor extends BaseHook
Properties
| Controller | $mod | Instance providing the hook |
from BaseHook |
| array | $_hook_info | Hook Information "id" => "4914" "instance_id" => "api_microsoft" "name" => "oauth_client" "hook" => "webservice.oauth_client" "type" => "object" "registry_name" => "oauth_client" "function_name" => "" "internal" => "no" "dep_mode" => "local" "active" => "yes" "title" => "Basic functions" "description" => "" "options" => "" |
from BaseHook |
Methods
Get Hook identifier consists of instance_id puncto separator and hook name Ex. instance_id.name
Return Hook information (ID, InstanceID, Name, Hook Type, Object Type, ...)
Returns true if this hook is available otherwise false.
Maintenance Function which will be calls every time a scheduled Background Update should be run This function can be used to trigger mass-updates on the search
This function is called for each indexed document and gets an array with the SearchIndexRecords of this specific document.
Details
in
BaseHook at line 76
string
getHookDescription()
No description
in
BaseHook at line 55
string
getHookIdentifier()
Get Hook identifier consists of instance_id puncto separator and hook name Ex. instance_id.name
in
BaseHook at line 45
array
getHookInfoValue(bool $key = false)
Return Hook information (ID, InstanceID, Name, Hook Type, Object Type, ...)
in
BaseHook at line 69
string
getHookInstance()
No description
in
BaseHook at line 62
string
getHookName()
No description
in
BaseHook at line 83
string
getHookTitle()
No description
in
BaseHook at line 88
getObject()
No description
at line 38
bool
isAvailable()
Returns true if this hook is available otherwise false.
at line 29
bool
onBackgroundUpdate()
Maintenance Function which will be calls every time a scheduled Background Update should be run This function can be used to trigger mass-updates on the search
at line 21
abstract SearchIndexRecord
preProcessDocument(SearchIndexRecord $searchDocument)
This function is called for each indexed document and gets an array with the SearchIndexRecords of this specific document.
The PreProcessor can modify these search index records before they will be committed to the search index (e.g. add additional index content, add language variants etc.) The functions must return an array with the modified SearchIndexRecords