class IndexEventDocumentIndexEvent extends IndexEventHook

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

Class IndexEventDocumentIndexEvent

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()

Returns true if this hook is available otherwise false.

null
process_document_index(DocumentIndex $documentIndex, string $event, int $eventUserId = NULL)

No description

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

in IndexEventHook at line 18
bool isAvailable()

Returns true if this hook is available otherwise false.

Return Value

bool

at line 27
null process_document_index(DocumentIndex $documentIndex, string $event, int $eventUserId = NULL)

No description

Parameters

DocumentIndex $documentIndex
string $event

[new|update|delete|discovery] - prefer usage of IndexEventInterface::EVENT_DISCOVERY

int $eventUserId

Return Value

null

Exceptions

Exception