progress_trace_buffer Class Reference

Special type of trace that can be used for catching of output of other traces. More...

Inheritance diagram for progress_trace_buffer:

Public Member Functions
	__construct (progress_trace $trace, $passthrough=true)
	Constructor.
	finished ()
	Called when the processing is finished.
	get_buffer ()
	Return internal text buffer.
	output ($message, $depth=0)
	Output the trace message.
	reset_buffer ()
	Reset internal text buffer.

Protected Attributes
string	$buffer
	output buffer
bool	$passthrough
	do we pass output out
progress_trace	$trace

Detailed Description

Special type of trace that can be used for catching of output of other traces.

Copyright

Petr Skoda

License

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

Constructor & Destructor Documentation

__construct()

progress_trace_buffer::__construct	(	progress_trace	$trace,
			$passthrough = true )

Constructor.

Parameters

progress_trace	$trace
bool	$passthrough	true means output and buffer, false means just buffer and no output

Member Function Documentation

finished()

progress_trace_buffer::finished

(

)

Called when the processing is finished.

Reimplemented from progress_trace.

get_buffer()

progress_trace_buffer::get_buffer

(

)

Return internal text buffer.

Return values

string

buffered plain text

output()

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

Output the trace message.

Parameters

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

Return values

void	output stored in buffer

Reimplemented from progress_trace.

---

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

• lib/weblib.php