Documentation

PHPUnit_Util_TestDox_ResultPrinter extends PHPUnit_Util_Printer
in package
implements PHPUnit_Framework_TestListener

Base class for printers of TestDox documentation.

Tags
since

Class available since Release 2.1.0

Interfaces, Classes and Traits

PHPUnit_Framework_TestListener
A Listener for test progress.

Table of Contents

$autoFlush  : bool
If true, flush output after every write.
$currentTestClassPrettified  : string
$currentTestMethodPrettified  : string
$failed  : int
$incomplete  : int
$out  : resource
$outTarget  : string
$prettifier  : PHPUnit_Util_TestDox_NamePrettifier
$printsHTML  : bool
$risky  : int
$skipped  : int
$successful  : int
$testClass  : string
$tests  : array<string|int, mixed>
$testStatus  : int
__construct()  : mixed
Constructor.
addError()  : mixed
An error occurred.
addFailure()  : mixed
A failure occurred.
addIncompleteTest()  : mixed
Incomplete test.
addRiskyTest()  : mixed
Risky test.
addSkippedTest()  : mixed
Skipped test.
endTest()  : mixed
A test ended.
endTestSuite()  : mixed
A testsuite ended.
flush()  : mixed
Flush buffer and close output.
getAutoFlush()  : bool
Check auto-flush mode.
incrementalFlush()  : mixed
Performs a safe, incremental flush.
setAutoFlush()  : mixed
Set auto-flushing mode.
startTest()  : mixed
A test started.
startTestSuite()  : mixed
A testsuite started.
write()  : mixed
doEndClass()  : mixed
endClass()  : mixed
Handler for 'end class' event.
endRun()  : mixed
Handler for 'end run' event.
onTest()  : mixed
Handler for 'on test' event.
startClass()  : mixed
Handler for 'start class' event.
startRun()  : mixed
Handler for 'start run' event.
isOfInterest()  : mixed

Properties

$autoFlush

If true, flush output after every write.

protected bool $autoFlush = alse

$currentTestClassPrettified

protected string $currentTestClassPrettified

$currentTestMethodPrettified

protected string $currentTestMethodPrettified

$outTarget

protected string $outTarget

$printsHTML

protected bool $printsHTML = alse

Methods

__construct()

Constructor.

public __construct([resource $out = null ]) : mixed
Parameters
$out : resource = null
Return values
mixed

flush()

Flush buffer and close output.

public flush() : mixed
Return values
mixed

getAutoFlush()

Check auto-flush mode.

public getAutoFlush() : bool
Tags
since

Method available since Release 3.3.0

Return values
bool

incrementalFlush()

Performs a safe, incremental flush.

public incrementalFlush() : mixed

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.

Tags
since

Method available since Release 3.3.0

Return values
mixed

setAutoFlush()

Set auto-flushing mode.

public setAutoFlush(bool $autoFlush) : mixed

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
$autoFlush : bool
Tags
since

Method available since Release 3.3.0

Return values
mixed

write()

public write(string $buffer) : mixed
Parameters
$buffer : string
Return values
mixed

doEndClass()

protected doEndClass() : mixed
Tags
since

Method available since Release 2.3.0

Return values
mixed

endClass()

Handler for 'end class' event.

protected endClass(string $name) : mixed
Parameters
$name : string
Return values
mixed

endRun()

Handler for 'end run' event.

protected endRun() : mixed
Return values
mixed

onTest()

Handler for 'on test' event.

protected onTest(string $name[, bool $success = true ]) : mixed
Parameters
$name : string
$success : bool = true
Return values
mixed

startClass()

Handler for 'start class' event.

protected startClass(string $name) : mixed
Parameters
$name : string
Return values
mixed

startRun()

Handler for 'start run' event.

protected startRun() : mixed
Return values
mixed

Search results