tool_uploaduser\local\cli_progress_tracker Class Reference

Tracks the progress of the user upload and outputs it in CLI script (writes to STDOUT) More...

Inheritance diagram for tool_uploaduser\local\cli_progress_tracker:

Public Member Functions
	close ()
	Print the table end.
	flush ()
	Flush previous line and start a new one.
	start ()
	Print table header.
	track ($col, $msg, $level='normal', $merge=true)
	Add tracking info.

Public Attributes
array	$columns = []
	The columns shown on the table.

Protected Member Functions
	output_line (string $line)
	Output one line (followed by newline)

Protected Attributes
array	$_row
array	$headers = []
	column headers

Detailed Description

Tracks the progress of the user upload and outputs it in CLI script (writes to STDOUT)

Copyright

2020 Marina Glancy

License

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

Member Function Documentation

close()

tool_uploaduser\local\text_progress_tracker::close ( )

inherited

Print the table end.

Return values

void

Reimplemented from uu_progress_tracker.

flush()

tool_uploaduser\local\text_progress_tracker::flush ( )

inherited

Flush previous line and start a new one.

Return values

void

Reimplemented from uu_progress_tracker.

output_line()

tool_uploaduser\local\cli_progress_tracker::output_line ( string $line )

protected

Output one line (followed by newline)

Parameters

string

$line

Reimplemented from tool_uploaduser\local\text_progress_tracker.

start()

tool_uploaduser\local\text_progress_tracker::start ( )

inherited

Print table header.

Return values

void

Reimplemented from uu_progress_tracker.

track()

tool_uploaduser\local\text_progress_tracker::track ( $col, $msg, $level = 'normal', $merge = true )

inherited

Add tracking info.

Parameters

string	$col	name of column
string	$msg	message
string	$level	'normal', 'warning' or 'error'
bool	$merge	true means add as new line, false means override all previous text of the same type

Return values

void

Reimplemented from uu_progress_tracker.

---

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

• admin/tool/uploaduser/classes/local/cli_progress_tracker.php