SimpleReporterDecorator Class Reference

Inheritance diagram for SimpleReporterDecorator:

Public Member Functions
	SimpleReporterDecorator (&$reporter)
	makeDry ($is_dry=true)
	getStatus ()
	shouldInvoke ($test_case_name, $method)
&	createInvoker (&$invoker)
	getDumper ()
	paintGroupStart ($test_name, $size)
	paintGroupEnd ($test_name)
	paintCaseStart ($test_name)
	paintCaseEnd ($test_name)
	paintMethodStart ($test_name)
	paintMethodEnd ($test_name)
	paintPass ($message)
	paintFail ($message)
	paintError ($message)
	paintException ($exception)
	paintSkip ($message)
	paintMessage ($message)
	paintFormattedMessage ($message)
	paintSignal ($type, &$payload)
Data Fields
	$_reporter

---

Detailed Description

Definition at line 418 of file scorer.php.

---

Member Function Documentation

& createInvoker

(

&$

invoker

)

Can wrap the invoker in preperation for running a test.

Parameters:

SimpleInvoker

$invoker

Individual test runner.

Returns:

SimpleInvoker Wrapped test runner. public

Definition at line 469 of file scorer.php.

getDumper

(

)

Gets the formatter for variables and other small generic data items.

Returns:

SimpleDumper Formatter. public

Definition at line 479 of file scorer.php.

getStatus

(

)

Accessor for current status. Will be false if there have been any failures or exceptions. Used for command line tools.

Returns:

boolean True if no failures. public

Definition at line 447 of file scorer.php.

makeDry

(

$

is_dry = true

)

Signals that the next evaluation will be a dry run. That is, the structure events will be recorded, but no tests will be run.

Parameters:

boolean

$is_dry

Dry run if true. public

Definition at line 436 of file scorer.php.

paintCaseEnd

(

$

test_name

)

Paints the end of a test case.

Parameters:

string

$test_name

Name of test or other label. public

Definition at line 516 of file scorer.php.

paintCaseStart

(

$

test_name

)

Paints the start of a test case.

Parameters:

string

$test_name

Name of test or other label. public

Definition at line 507 of file scorer.php.

paintError

(

$

message

)

Chains to the wrapped reporter.

Parameters:

string

$message

Text of error formatted by the test case. public

Definition at line 562 of file scorer.php.

paintException

(

$

exception

)

Chains to the wrapped reporter.

Parameters:

Exception

$exception

Exception to show. public

Definition at line 571 of file scorer.php.

paintFail

(

$

message

)

Chains to the wrapped reporter.

Parameters:

string

$message

Message is ignored. public

Definition at line 552 of file scorer.php.

paintFormattedMessage

(

$

message

)

Chains to the wrapped reporter.

Parameters:

string

$message

Text to display. public

Definition at line 598 of file scorer.php.

paintGroupEnd

(

$

test_name

)

Paints the end of a group test.

Parameters:

string

$test_name

Name of test or other label. public

Reimplemented in SelectiveReporter.

Definition at line 498 of file scorer.php.

paintGroupStart	(	$	test_name,
		$	size
	)

Paints the start of a group test.

Parameters:

string	$test_name	Name of test or other label.
integer	$size	Number of test cases starting. public

Reimplemented in SelectiveReporter.

Definition at line 489 of file scorer.php.

paintMessage

(

$

message

)

Chains to the wrapped reporter.

Parameters:

string

$message

Text to display. public

Definition at line 589 of file scorer.php.

paintMethodEnd

(

$

test_name

)

Paints the end of a test method.

Parameters:

string

$test_name

Name of test or other label. public

Definition at line 534 of file scorer.php.

paintMethodStart

(

$

test_name

)

Paints the start of a test method.

Parameters:

string

$test_name

Name of test or other label. public

Definition at line 525 of file scorer.php.

paintPass

(

$

message

)

Chains to the wrapped reporter.

Parameters:

string

$message

Message is ignored. public

Definition at line 543 of file scorer.php.

paintSignal	(	$	type,
		&$	payload
	)

Chains to the wrapped reporter.

Parameters:

string	$type	Event type as text.
mixed	$payload	Message or object.

Returns:

boolean Should return false if this type of signal should fail the test suite. public

Definition at line 611 of file scorer.php.

paintSkip

(

$

message

)

Prints the message for skipping tests.

Parameters:

string

$message

Text of skip condition. public

Reimplemented in NoSkipsReporter.

Definition at line 580 of file scorer.php.

shouldInvoke	(	$	test_case_name,
		$	method
	)

The reporter has a veto on what should be run.

Parameters:

string	$test_case_name	name of test case.
string	$method	Name of test method.

Returns:

boolean True if test should be run. public

Reimplemented in SelectiveReporter.

Definition at line 458 of file scorer.php.

SimpleReporterDecorator

(

&$

reporter

)

Mediates between the reporter and the test case.

Parameters:

SimpleScorer

$reporter

Reporter to receive events.

Definition at line 425 of file scorer.php.

Here is the caller graph for this function:

---

Field Documentation

$_reporter

Definition at line 419 of file scorer.php.

---

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

• C:/xampp/htdocs/moodle/lib/simpletestlib/scorer.php