PHPUnit\Util\Printer Class Reference

Inheritance diagram for PHPUnit\Util\Printer:

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

Protected Attributes
	$autoFlush = false
	$out
	$outTarget

Constructor & Destructor Documentation

__construct()

PHPUnit\Util\Printer::__construct

(

$out = null

)

Constructor.

Parameters

null | resource | string

$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\TestDox\TestDoxPrinter, PHPUnit\Util\TestDox\ResultPrinter, PHPUnit\Util\Log\JUnit, and PHPUnit\Util\TestDox\XmlResultPrinter.

getAutoFlush()

PHPUnit\Util\Printer::getAutoFlush

(

)

Check auto-flush mode.

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

(

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.

write()

PHPUnit\Util\Printer::write

(

string

$buffer

)

Reimplemented in PHPUnit\Util\TestDox\TestableCliTestDoxPrinter.

Member Data Documentation

$autoFlush

PHPUnit\Util\Printer::$autoFlush = false

protected

$out

PHPUnit\Util\Printer::$out

protected

@psalm-var resource|closed-resource

$outTarget

PHPUnit\Util\Printer::$outTarget

protected

---

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

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