1. interface
  2. XELOS
  3. \
  4. Framework
  5. \
  6. Core
  7. \
  8. Interfaces
  9. \
  10. IndexEventInterface

IndexEventInterface

interface IndexEventInterface

Constants

EVENT_NEW

Document was created recently by a user
EVENT_UPDATE

Document was updated recently by a user
EVENT_DELETE

Document was deleted recently by a user, be aware the the original document will not exist anymore and only the index remains
EVENT_COMMENT

A comment was added to this document by a user
deprecated EVENT_VIEW

The document is considered 'seen' by a certain user.
EVENT_DISCOVERY

During consistency check we found a new document which was not present in the index yet and we are now adding it the document is usually not older than 24h as a consistency check is usually run every 24h
EVENT_REINDEX

The system is requesting a reindexing of the document, this is usually triggered by an administrator detecting an anomaly.

You should not be sending notifications and emails in this event but make sure that your dependencies (e.g. search index, references) are consistent to this document

Methods

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

Process Document Event

Details

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

Process Document Event

Parameters

DocumentIndex $document_index
string $event

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

Event triggered by user_id

Return Value

null