PHPUnit\Util\Printer Class Reference

Inheritance diagram for PHPUnit\Util\Printer:

Public Member Functions
	__construct ($out=null)
	flush ()
	incrementalFlush ()
	write ($buffer)
	getAutoFlush ()
	setAutoFlush ($autoFlush)

Protected Attributes
	$autoFlush = false
	$out
	$outTarget

Detailed Description

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

Constructor & Destructor Documentation

__construct()

PHPUnit\Util\Printer::__construct

(

$out = null

)

Constructor.

Parameters

mixed

$out

Exceptions

Exception

Reimplemented in PHPUnit\Util\TestDox\XmlResultPrinter.

Member Function Documentation

flush()

PHPUnit\Util\Printer::flush

(

)

Flush buffer and close output if it's not to a PHP stream

Reimplemented in PHPUnit\Util\Log\JUnit, PHPUnit\Util\TestDox\ResultPrinter, and PHPUnit\Util\TestDox\XmlResultPrinter.

getAutoFlush()

PHPUnit\Util\Printer::getAutoFlush

(

)

Check auto-flush mode.

Returns

bool

incrementalFlush()

PHPUnit\Util\Printer::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.

setAutoFlush()

PHPUnit\Util\Printer::setAutoFlush

(

$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

write()

PHPUnit\Util\Printer::write

(

$buffer

)

Parameters

string

$buffer

---

The documentation for this class was generated from the following file:

• vendor/phpunit/phpunit/src/Util/Printer.php