Moodle APIs 3.9
Moodle 3.9.13+ (Build: 20220325)
Public Member Functions | List of all members
core\log\reader Interface Reference
Inheritance diagram for core\log\reader:
core\log\sql_reader core\log\sql_internal_table_reader logstore_database\log\store logstore_legacy\log\store logstore_standard\log\store

Public Member Functions

 get_description ()
 Longer description of the log data source. More...
 
 get_name ()
 Localised name of the reader. More...
 
 is_logging ()
 Are the new events appearing in the reader? More...
 

Member Function Documentation

◆ get_description()

core\log\reader::get_description ( )

Longer description of the log data source.

Return values
string

◆ get_name()

core\log\reader::get_name ( )

Localised name of the reader.

To be used in selection for in reports.

Return values
string

◆ is_logging()

core\log\reader::is_logging ( )

Are the new events appearing in the reader?

Return values
booltrue means new log events are being added, false means no new data will be added

Implemented in logstore_database\log\store, logstore_legacy\log\store, and logstore_standard\log\store.


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