• Home
  • SimpleReporterDecorator

PHP Class SimpleReporterDecorator, simpletest

@package SimpleTest
Show file Open project: simpletest/simpletest Class Usage Examples

Protected Properties

Property Type Description
$reporter

Public Methods

Method Description
__construct ( SimpleScorer $reporter ) Mediates between the reporter and the test case.
createInvoker ( SimpleInvoker $invoker ) : SimpleInvoker Can wrap the invoker in preparation for running a test.
getDumper ( ) : SimpleDumper Gets the formatter for privateiables and other small generic data items.
getStatus ( ) : boolean Accessor for current status.
getTestList ( ) : array The nesting of the test cases so far. Not all reporters have this facility.
makeDry ( boolean $is_dry = true ) Signals that the next evaluation will be a dry run.
paintCaseEnd ( string $test_name ) Paints the end of a test case.
paintCaseStart ( string $test_name ) Paints the start of a test case.
paintError ( string $message ) Chains to the wrapped reporter.
paintException ( Exception $exception ) Chains to the wrapped reporter.
paintFail ( string $message ) Chains to the wrapped reporter.
paintFormattedMessage ( string $message ) Chains to the wrapped reporter.
paintGroupEnd ( string $test_name ) Paints the end of a group test.
paintGroupStart ( string $test_name, integer $size ) Paints the start of a group test.
paintMessage ( string $message ) Chains to the wrapped reporter.
paintMethodEnd ( string $test_name ) Paints the end of a test method.
paintMethodStart ( string $test_name ) Paints the start of a test method.
paintPass ( string $message ) Chains to the wrapped reporter.
paintSignal ( string $type, mixed $payload ) : boolean Chains to the wrapped reporter.
paintSkip ( string $message ) Prints the message for skipping tests.
shouldInvoke ( string $test_case_name, string $method ) : boolean The reporter has a veto on what should be run.

Method Details

__construct() public method

Mediates between the reporter and the test case.
public __construct ( SimpleScorer $reporter )
$reporter SimpleScorer Reporter to receive events.

createInvoker() public method

Can wrap the invoker in preparation for running a test.
public createInvoker ( SimpleInvoker $invoker ) : SimpleInvoker
$invoker SimpleInvoker Individual test runner.
return SimpleInvoker Wrapped test runner.

getDumper() public method

Gets the formatter for privateiables and other small generic data items.
public getDumper ( ) : SimpleDumper
return SimpleDumper Formatter.

getStatus() public method

Will be false if there have been any failures or exceptions. Used for command line tools.
public getStatus ( ) : boolean
return boolean True if no failures.

getTestList() public method

The nesting of the test cases so far. Not all reporters have this facility.
public getTestList ( ) : array
return array Test list if accessible.

makeDry() public method

That is, the structure events will be recorded, but no tests will be run.
public makeDry ( boolean $is_dry = true )
$is_dry boolean Dry run if true.

paintCaseEnd() public method

Paints the end of a test case.
public paintCaseEnd ( string $test_name )
$test_name string Name of test or other label.

paintCaseStart() public method

Paints the start of a test case.
public paintCaseStart ( string $test_name )
$test_name string Name of test or other label.

paintError() public method

Chains to the wrapped reporter.
public paintError ( string $message )
$message string Text of error formatted by the test case.

paintException() public method

Chains to the wrapped reporter.
public paintException ( Exception $exception )
$exception Exception Exception to show.

paintFail() public method

Chains to the wrapped reporter.
public paintFail ( string $message )
$message string Message is ignored.

paintFormattedMessage() public method

Chains to the wrapped reporter.
public paintFormattedMessage ( string $message )
$message string Text to display.

paintGroupEnd() public method

Paints the end of a group test.
public paintGroupEnd ( string $test_name )
$test_name string Name of test or other label.

paintGroupStart() public method

Paints the start of a group test.
public paintGroupStart ( string $test_name, integer $size )
$test_name string Name of test or other label.
$size integer Number of test cases starting.

paintMessage() public method

Chains to the wrapped reporter.
public paintMessage ( string $message )
$message string Text to display.

paintMethodEnd() public method

Paints the end of a test method.
public paintMethodEnd ( string $test_name )
$test_name string Name of test or other label.

paintMethodStart() public method

Paints the start of a test method.
public paintMethodStart ( string $test_name )
$test_name string Name of test or other label.

paintPass() public method

Chains to the wrapped reporter.
public paintPass ( string $message )
$message string Message is ignored.

paintSignal() public method

Chains to the wrapped reporter.
public paintSignal ( string $type, mixed $payload ) : boolean
$type string Event type as text.
$payload mixed Message or object.
return boolean Should return false, if this type of signal should fail the test suite.

paintSkip() public method

Prints the message for skipping tests.
public paintSkip ( string $message )
$message string Text of skip condition.

shouldInvoke() public method

The reporter has a veto on what should be run.
public shouldInvoke ( string $test_case_name, string $method ) : boolean
$test_case_name string Name of test case.
$method string Name of test method.
return boolean True if test should be run.

Property Details

$reporter protected property

protected $reporter