progress_trace Class Reference

Progress trace class. More...

Inheritance diagram for progress_trace:

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

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.

Copyright

2009 Tim Hunt

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 html_list_progress_trace, progress_trace_buffer, and combined_progress_trace.

output()

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

abstract

Output an progress message in whatever format.

Parameters

string	$message	the message to output.
integer	$depth	indent depth for this message.

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

---

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

• lib/weblib.php