Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
tool_log\log\manager Class Reference
Inheritance diagram for tool_log\log\manager:
core\log\manager

Public Member Functions

 dispose ()
 Usually called automatically from shutdown manager, this allows us to implement buffering of write operations.
 
 get_readers ($interface=null)
 Returns list of available log readers.
 
 get_supported_logstores ($component)
 For a given report, returns a list of log stores that are supported.
 
 get_supported_reports ($logstore)
 Get a list of reports that support the given store instance.
 
 process (\core\event\base $event)
 Called from the observer only.
 

Static Public Member Functions

static get_store_plugins ()
 Intended for store management, do not use from reports.
 

Protected Member Functions

 init ()
 Delayed initialisation of singleton.
 

Protected Attributes

core log reader[] $readers
 $readers list of initialised log readers
 
tool_log log store[] $stores
 $stores list of all enabled stores
 
tool_log log writer[] $writers
 $writers list of initialised log writers
 

Member Function Documentation

◆ dispose()

tool_log\log\manager::dispose ( )

Usually called automatically from shutdown manager, this allows us to implement buffering of write operations.

Implements core\log\manager.

◆ get_readers()

tool_log\log\manager::get_readers ( $interface = null)

Returns list of available log readers.

This way the reports find out available sources of data.

Parameters
string$interfaceReturned stores must implement this interface.
Return values
core\log\reader[]list of available log data readers

Implements core\log\manager.

◆ get_store_plugins()

static tool_log\log\manager::get_store_plugins ( )
static

Intended for store management, do not use from reports.

Return values
store[]Returns list of available store plugins.

◆ get_supported_logstores()

tool_log\log\manager::get_supported_logstores ( $component)

For a given report, returns a list of log stores that are supported.

Parameters
string$componentcomponent.
Return values
false|arraylist of logstores that support the given report. It returns false if the given $component doesn't require logstores.

Implements core\log\manager.

◆ get_supported_reports()

tool_log\log\manager::get_supported_reports ( $logstore)

Get a list of reports that support the given store instance.

Parameters
string$logstoreName of the store.
Return values
arrayList of supported reports

◆ process()

tool_log\log\manager::process ( \core\event\base $event)

Called from the observer only.

Parameters
core\event\base$event

The documentation for this class was generated from the following file: