1. class
  2. PHPUnit
  3. \
  4. Util
  5. \
  6. TestDox
  7. \
  8. ResultPrinter

ResultPrinter

class ResultPrinter extends Printer implements TestListener (View source)

Base class for printers of TestDox documentation.

Properties

protected bool $autoFlush If true, flush output after every write. from Printer
protected resource $out from Printer
protected string $outTarget from Printer
protected NamePrettifier $prettifier
protected string $testClass
protected int $testStatus
protected array $tests
protected int $successful
protected int $warned
protected int $failed
protected int $risky
protected int $skipped
protected int $incomplete
protected string|null $currentTestClassPrettified
protected string|null $currentTestMethodPrettified

Methods

__construct(mixed $out = null, array $groups = [], array $excludeGroups = [])

No description

flush()

Flush buffer and close output.

incrementalFlush()

Performs a safe, incremental flush.

from Printer
write(string $buffer)

No description

from Printer
bool
getAutoFlush()

Check auto-flush mode.

from Printer
setAutoFlush(bool $autoFlush)

Set auto-flushing mode.

from Printer
addError(Test $test, Exception $e, float $time)

An error occurred.

addWarning(Test $test, Warning $e, float $time)

A warning occurred.

addFailure(Test $test, AssertionFailedError $e, float $time)

A failure occurred.

addIncompleteTest(Test $test, Exception $e, float $time)

Incomplete test.

addRiskyTest(Test $test, Exception $e, float $time)

Risky test.

addSkippedTest(Test $test, Exception $e, float $time)

Skipped test.

startTestSuite(TestSuite $suite)

A testsuite started.

endTestSuite(TestSuite $suite)

A testsuite ended.

startTest(Test $test)

A test started.

endTest(Test $test, float $time)

A test ended.

doEndClass()

No description

startRun()

Handler for 'start run' event.

startClass(string $name)

Handler for 'start class' event.

onTest(string $name, bool $success = true)

Handler for 'on test' event.

endClass(string $name)

Handler for 'end class' event.

endRun()

Handler for 'end run' event.

Details

at line 102
__construct(mixed $out = null, array $groups = [], array $excludeGroups = [])

Parameters

mixed $out
array $groups
array $excludeGroups

at line 116
flush()

Flush buffer and close output.

in Printer at line 87
incrementalFlush()

Performs a safe, incremental flush.

Do not confuse this function with the flush() function of this class, since the flush() function may close the file being written to, rendering the current object no longer usable.

in Printer at line 99
write(string $buffer)

Parameters

string $buffer

in Printer at line 125
bool getAutoFlush()

Check auto-flush mode.

Return Value

bool

in Printer at line 138
setAutoFlush(bool $autoFlush)

Set auto-flushing mode.

If set, incremental flushes will be done after each write. This should not be confused with the different effects of this class' flush() method.

Parameters

bool $autoFlush

at line 131
addError(Test $test, Exception $e, float $time)

An error occurred.

Parameters

Test $test
Exception $e
float $time

at line 148
addWarning(Test $test, Warning $e, float $time)

A warning occurred.

Parameters

Test $test
Warning $e
float $time

at line 165
addFailure(Test $test, AssertionFailedError $e, float $time)

A failure occurred.

Parameters

Test $test
AssertionFailedError $e
float $time

at line 182
addIncompleteTest(Test $test, Exception $e, float $time)

Incomplete test.

Parameters

Test $test
Exception $e
float $time

at line 199
addRiskyTest(Test $test, Exception $e, float $time)

Risky test.

Parameters

Test $test
Exception $e
float $time

at line 216
addSkippedTest(Test $test, Exception $e, float $time)

Skipped test.

Parameters

Test $test
Exception $e
float $time

at line 231
startTestSuite(TestSuite $suite)

A testsuite started.

Parameters

TestSuite $suite

at line 240
endTestSuite(TestSuite $suite)

A testsuite ended.

Parameters

TestSuite $suite

at line 249
startTest(Test $test)

A test started.

Parameters

Test $test

at line 298
endTest(Test $test, float $time)

A test ended.

Parameters

Test $test
float $time

at line 324
protected doEndClass()

at line 336
protected startRun()

Handler for 'start run' event.

at line 345
protected startClass(string $name)

Handler for 'start class' event.

Parameters

string $name

at line 355
protected onTest(string $name, bool $success = true)

Handler for 'on test' event.

Parameters

string $name
bool $success

at line 364
protected endClass(string $name)

Handler for 'end class' event.

Parameters

string $name

at line 371
protected endRun()

Handler for 'end run' event.