Moodle PHP Documentation 4.4
Moodle 4.4.1 (Build: 20240610) (db07c09afc5)
core\log\manager Interface Reference

Interface describing log readers. More...

Inheritance diagram for core\log\manager:
core\log\dummy_manager tool_log\log\manager

Public Member Functions

 dispose ()
 Dispose all initialised stores.
 
 get_readers ($interface=null)
 Return list of available log readers.
 
 get_supported_logstores ($component)
 For a given report, returns a list of log stores that are supported.
 

Detailed Description

Interface describing log readers.

This is intended for reports, use get_log_manager() to get the configured instance.

Member Function Documentation

◆ dispose()

core\log\manager::dispose ( )

Dispose all initialised stores.

Return values
void

Implemented in core\log\dummy_manager, and tool_log\log\manager.

◆ get_readers()

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

Return list of available log readers.

Parameters
string$interfaceAll returned readers must implement this interface.
Return values
core\log\reader[]

Implemented in core\log\dummy_manager, and tool_log\log\manager.

◆ get_supported_logstores()

core\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.

Implemented in core\log\dummy_manager, and tool_log\log\manager.


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