Moodle PHP Documentation 4.2
Moodle 4.2.8 (Build: 20240610) (2d41ac46f45)
loggable Interface Reference

Interface to apply to all the classes we want to be able to write to logs. More...

Inheritance diagram for loggable:
backup_plan base_controller base_converter base_step base_task moodle1_file_manager moodle1_handler restore_plan

Public Member Functions

 log ($message, $level, $a=null, $depth=null, $display=false)
 This function will be responsible for handling the params, and to call to the corresponding logger->process() once all modifications in params have been performed.
 

Detailed Description

Interface to apply to all the classes we want to be able to write to logs.

Any class being part of one backup/restore and needing to senf informatio to logs must implement this interface (and have access to the @logger instantiated object)

TODO: Finish phpdocs

Member Function Documentation

◆ log()

loggable::log ( $message,
$level,
$a = null,
$depth = null,
$display = false )

This function will be responsible for handling the params, and to call to the corresponding logger->process() once all modifications in params have been performed.

Implemented in backup_plan, base_controller, base_converter, base_step, base_task, imscc11_converter, imscc1_converter, moodle1_converter, moodle1_file_manager, moodle1_handler, and restore_plan.


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