IndexEventDocumentIndexEvent
class IndexEventDocumentIndexEvent extends IndexEventHook
Class IndexEventDocumentIndexEvent
Properties
CommentsController | $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
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, ...)
Notify users that someone commented on their 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
in
IndexEventHook at line 18
bool
isAvailable()
Returns true if this hook is available otherwise false.
at line 31
null
process_document_index(DocumentIndex $document_index, string $event, int $event_user_id = null)
Notify users that someone commented on their document