Documentation

PHPUnit_Util_Printer
in package

Utility class that can print to STDOUT or write to a file.

Tags
since

Class available since Release 2.0.0

Table of Contents

$autoFlush  : bool
If true, flush output after every write.
$out  : resource
$outTarget  : string
$printsHTML  : bool
__construct()  : mixed
Constructor.
flush()  : mixed
Flush buffer, optionally tidy up HTML, and close output if it's not to a php stream
getAutoFlush()  : bool
Check auto-flush mode.
incrementalFlush()  : mixed
Performs a safe, incremental flush.
setAutoFlush()  : mixed
Set auto-flushing mode.
write()  : mixed

Properties

$autoFlush

If true, flush output after every write.

protected bool $autoFlush = alse

$outTarget

protected string $outTarget

$printsHTML

protected bool $printsHTML = alse

Methods

__construct()

Constructor.

public __construct([mixed $out = null ]) : mixed
Parameters
$out : mixed = null
Tags
throws
PHPUnit_Framework_Exception
Return values
mixed

flush()

Flush buffer, optionally tidy up HTML, and close output if it's not to a php stream

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

Search results