IEventLogger
Interface IEventLogger
Tags
Table of Contents
- activate() : mixed
- Activate the module for the duration of the request. Deactivated module does not create and store \OCP\Diagnostics\IEvent objects.
- end() : mixed
- Mark the end of an event with specific ID $id, marked by start() method.
- getEvents() : \OCP\Diagnostics\IEvent[]
- This method should return all \OCP\Diagnostics\IEvent objects stored using start()/end() or log() methods
- log() : mixed
- Mark the start and the end of an event with specific ID $id and description $description, explicitly marking start and end of the event, represented by $start and $end timestamps.
- start() : mixed
- Mark the start of an event setting its ID $id and providing event description $description.
Methods
activate()
Activate the module for the duration of the request. Deactivated module does not create and store \OCP\Diagnostics\IEvent objects.
public
activate() : mixed
Only activated module should create and store objects to be returned with getEvents() call.
Tags
Return values
mixed —end()
Mark the end of an event with specific ID $id, marked by start() method.
public
end(string $id) : mixed
Ending event should store \OCP\Diagnostics\IEvent to be returned with getEvents() method.
Parameters
- $id : string
Tags
Return values
mixed —getEvents()
This method should return all \OCP\Diagnostics\IEvent objects stored using start()/end() or log() methods
public
getEvents() : \OCP\Diagnostics\IEvent[]
Tags
Return values
\OCP\Diagnostics\IEvent[] —log()
Mark the start and the end of an event with specific ID $id and description $description, explicitly marking start and end of the event, represented by $start and $end timestamps.
public
log(string $id, string $description, float $start, float $end) : mixed
Logging event should store \OCP\Diagnostics\IEvent to be returned with getEvents() method.
Parameters
- $id : string
- $description : string
- $start : float
- $end : float
Tags
Return values
mixed —start()
Mark the start of an event setting its ID $id and providing event description $description.
public
start(string $id, string $description) : mixed
Parameters
- $id : string
- $description : string