tool_uploadcourse_tracker Class Reference

Class output tracker. More...

Public Member Functions
	__construct ($outputmode=self::NO_OUTPUT)
	Constructor.
	finish ()
	Finish the output.
	output ($line, $outcome, $status, $data)
	Output one more line.
	results ($total, $created, $updated, $deleted, $errors)
	Output the results.
	start ()
	Start the output.

Public Attributes
const	NO_OUTPUT = 0
	Constant to output nothing.
const	OUTPUT_HTML = 1
	Constant to output HTML.
const	OUTPUT_PLAIN = 2
	Constant to output plain text.

Protected Attributes
object	$buffer
	output buffer.
array	$columns = array('line', 'result', 'id', 'shortname', 'fullname', 'idnumber', 'status')
	columns to display.
int	$outputmode
	chosen output mode.
int	$rownb = 0
	row number.

Detailed Description

Class output tracker.

Copyright

2013 Frédéric Massart

License

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

Constructor & Destructor Documentation

__construct()

tool_uploadcourse_tracker::__construct

(

$outputmode = self::NO_OUTPUT

)

Constructor.

Parameters

int

$outputmode

desired output mode.

Member Function Documentation

finish()

tool_uploadcourse_tracker::finish

(

)

Finish the output.

Return values

void

output()

tool_uploadcourse_tracker::output	(		$line,
			$outcome,
			$status,
			$data )

Output one more line.

Parameters

int	$line	line number.
bool	$outcome	success or not?
array	$status	array of statuses.
array	$data	extra data to display.

Return values

void

results()

tool_uploadcourse_tracker::results	(		$total,
			$created,
			$updated,
			$deleted,
			$errors )

Output the results.

Parameters

int	$total	total courses.
int	$created	count of courses created.
int	$updated	count of courses updated.
int	$deleted	count of courses deleted.
int	$errors	count of errors.

Return values

void

start()

tool_uploadcourse_tracker::start

(

)

Start the output.

Return values

void

---

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

• admin/tool/uploadcourse/classes/tracker.php