class TranslateDocumentSearchPreprocessor extends SearchPreprocessor

Is triggered when a document_index is created or modified. Check if the translation API has to be called.

Class IndexEventDocumentIndexEvent

Constants

TRANSLATIONITEM_TAG

Properties

TranslationController $mod
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

string
getHookDescription()

No description

from  BaseHook
string
getHookIdentifier()

Get Hook identifier consists of instance_id puncto separator and hook name Ex. instance_id.name

from  BaseHook
array
getHookInfoValue(bool $key = false)

Return Hook information (ID, InstanceID, Name, Hook Type, Object Type, ...)

from  BaseHook
string
getHookInstance()

No description

from  BaseHook
string
getHookName()

No description

from  BaseHook
string
getHookTitle()

No description

from  BaseHook
getObject()

No description

from  BaseHook
bool
isAvailable()

Determines if the translate search result config option is enabled

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

preProcessDocument(SearchIndexRecord $searchDocument)

Check for possible translations for the SearchIndexRecord. Create translation jobs, if there are translations missing

Details

in BaseHook at line 76
string getHookDescription()

No description

Return Value

string

in BaseHook at line 55
string getHookIdentifier()

Get Hook identifier consists of instance_id puncto separator and hook name Ex. instance_id.name

Return Value

string

in BaseHook at line 45
array getHookInfoValue(bool $key = false)

Return Hook information (ID, InstanceID, Name, Hook Type, Object Type, ...)

Parameters

bool $key

Return Value

array

in BaseHook at line 69
string getHookInstance()

No description

Return Value

string

in BaseHook at line 62
string getHookName()

No description

Return Value

string

in BaseHook at line 83
string getHookTitle()

No description

Return Value

string

in BaseHook at line 88
getObject()

No description

at line 29
bool isAvailable()

Determines if the translate search result config option is enabled

Return Value

bool

in SearchPreprocessor 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

Return Value

bool

Return true if operation has been finished successfull

at line 87
SearchIndexRecord preProcessDocument(SearchIndexRecord $searchDocument)

Check for possible translations for the SearchIndexRecord. Create translation jobs, if there are translations missing

Parameters

SearchIndexRecord $searchDocument

Return Value

SearchIndexRecord