PHPUnit_Util_TestDox_ResultPrinter
extends PHPUnit_Util_Printer
in package
implements
PHPUnit_Framework_TestListener
Base class for printers of TestDox documentation.
Tags
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
$failed
protected
int
$failed
= 0
$incomplete
protected
int
$incomplete
= 0
$out
protected
resource
$out
$outTarget
protected
string
$outTarget
$prettifier
protected
PHPUnit_Util_TestDox_NamePrettifier
$prettifier
$printsHTML
protected
bool
$printsHTML
= alse
$risky
protected
int
$risky
= 0
$skipped
protected
int
$skipped
= 0
$successful
protected
int
$successful
= 0
$testClass
protected
string
$testClass
= ''
$tests
protected
array<string|int, mixed>
$tests
= array()
$testStatus
protected
int
$testStatus
= alse
Methods
__construct()
Constructor.
public
__construct([resource $out = null ]) : mixed
Parameters
- $out : resource = null
Return values
mixed —addError()
An error occurred.
public
addError(PHPUnit_Framework_Test $test, Exception $e, float $time) : mixed
Parameters
- $test : PHPUnit_Framework_Test
- $e : Exception
- $time : float
Return values
mixed —addFailure()
A failure occurred.
public
addFailure(PHPUnit_Framework_Test $test, PHPUnit_Framework_AssertionFailedError $e, float $time) : mixed
Parameters
- $test : PHPUnit_Framework_Test
- $e : PHPUnit_Framework_AssertionFailedError
- $time : float
Return values
mixed —addIncompleteTest()
Incomplete test.
public
addIncompleteTest(PHPUnit_Framework_Test $test, Exception $e, float $time) : mixed
Parameters
- $test : PHPUnit_Framework_Test
- $e : Exception
- $time : float
Return values
mixed —addRiskyTest()
Risky test.
public
addRiskyTest(PHPUnit_Framework_Test $test, Exception $e, float $time) : mixed
Parameters
- $test : PHPUnit_Framework_Test
- $e : Exception
- $time : float
Tags
Return values
mixed —addSkippedTest()
Skipped test.
public
addSkippedTest(PHPUnit_Framework_Test $test, Exception $e, float $time) : mixed
Parameters
- $test : PHPUnit_Framework_Test
- $e : Exception
- $time : float
Tags
Return values
mixed —endTest()
A test ended.
public
endTest(PHPUnit_Framework_Test $test, float $time) : mixed
Parameters
- $test : PHPUnit_Framework_Test
- $time : float
Return values
mixed —endTestSuite()
A testsuite ended.
public
endTestSuite(PHPUnit_Framework_TestSuite $suite) : mixed
Parameters
- $suite : PHPUnit_Framework_TestSuite
Tags
Return values
mixed —flush()
Flush buffer and close output.
public
flush() : mixed
Return values
mixed —getAutoFlush()
Check auto-flush mode.
public
getAutoFlush() : bool
Tags
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
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
Return values
mixed —startTest()
A test started.
public
startTest(PHPUnit_Framework_Test $test) : mixed
Parameters
- $test : PHPUnit_Framework_Test
Return values
mixed —startTestSuite()
A testsuite started.
public
startTestSuite(PHPUnit_Framework_TestSuite $suite) : mixed
Parameters
- $suite : PHPUnit_Framework_TestSuite
Tags
Return values
mixed —write()
public
write(string $buffer) : mixed
Parameters
- $buffer : string
Return values
mixed —doEndClass()
protected
doEndClass() : mixed
Tags
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 —isOfInterest()
private
isOfInterest(PHPUnit_Framework_Test $test) : mixed
Parameters
- $test : PHPUnit_Framework_Test