Moodle PHP Documentation 4.5
Moodle 4.5dev (Build: 20240606) (d3ae1391abe)
progress_trace Class Reference

Progress trace class. More...

Inheritance diagram for progress_trace:
combined_progress_trace error_log_progress_trace html_list_progress_trace html_progress_trace null_progress_trace progress_trace_buffer text_progress_trace

Public Member Functions

 finished ()
 Called when the processing is finished.
 
 output ($message, $depth=0)
 Output an progress message in whatever format.
 

Detailed Description

Progress trace class.

Use this class from long operations where you want to output occasional information about what is going on, but don't know if, or in what format, the output should be.

License
http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

Member Function Documentation

◆ finished()

progress_trace::finished ( )

Called when the processing is finished.

Reimplemented in combined_progress_trace, html_list_progress_trace, and progress_trace_buffer.

◆ output()

progress_trace::output ( $message,
$depth = 0 )
abstract

Output an progress message in whatever format.

Parameters
string$messagethe message to output.
integer$depthindent depth for this message.

Reimplemented in combined_progress_trace, error_log_progress_trace, html_list_progress_trace, html_progress_trace, null_progress_trace, progress_trace_buffer, and text_progress_trace.


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