class WallIndexEventDocumentIndexEvent extends IndexEventHook

Class XELOS\Modules\SystemActionlog\Hook\System\xhook_system_actionlog_index_event

Properties

SystemActionlogController $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

__construct()

No description

bool
add_action_by_indexer($params)

No description

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
mixed
getOption(string $key)

Returns the option with $key set in the config.yml

from  BaseHook
bool
isAvailable()

Returns true if this hook is available otherwise false.

process_document_index(DocumentIndex $document_index, string $event, null|int $event_user_id = null)

Process Document Event

set_debug(bool $debugMode = true)

No description

Details

at line 35
__construct()

No description

at line 488
bool add_action_by_indexer($params)

No description

Parameters

$params

Return Value

bool

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 BaseHook at line 97
mixed getOption(string $key)

Returns the option with $key set in the config.yml

Parameters

string $key

Return Value

mixed

in IndexEventHook at line 18
bool isAvailable()

Returns true if this hook is available otherwise false.

Return Value

bool

at line 49
process_document_index(DocumentIndex $document_index, string $event, null|int $event_user_id = null)

Process Document Event

Parameters

DocumentIndex $document_index
string $event

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

null|int $event_user_id

Event triggered by user_id

Exceptions

Exception

at line 567
WallIndexEventDocumentIndexEvent set_debug(bool $debugMode = true)

No description

Parameters

bool $debugMode

Return Value

WallIndexEventDocumentIndexEvent