Utility class that can print to STDOUT or write to a file.
@package PHPUnit @subpackage Util @author Sebastian Bergmann <sebastian@phpunit.de> @copyright 2001-2013 Sebastian Bergmann <sebastian@phpunit.de> @license http://www.opensource.org/licenses/BSD-3-Clause The BSD 3-Clause License @link http://www.phpunit.de/ @since Class available since Release 2.0.0
Expanded class hierarchy of PHPUnit_Util_Printer
class PHPUnit_Util_Printer {
/**
* If TRUE, flush output after every write.
*
* @var boolean
*/
protected $autoFlush = FALSE;
/**
* @var resource
*/
protected $out;
/**
* @var string
*/
protected $outTarget;
/**
* @var boolean
*/
protected $printsHTML = FALSE;
/**
* Constructor.
*
* @param mixed $out
* @throws PHPUnit_Framework_Exception
*/
public function __construct($out = NULL) {
if ($out !== NULL) {
if (is_string($out)) {
if (strpos($out, 'socket://') === 0) {
$out = explode(':', str_replace('socket://', '', $out));
if (sizeof($out) != 2) {
throw new PHPUnit_Framework_Exception();
}
$this->out = fsockopen($out[0], $out[1]);
}
else {
if (strpos($out, 'php://') === FALSE && !is_dir(dirname($out))) {
mkdir(dirname($out), 0777, TRUE);
}
$this->out = fopen($out, 'wt');
}
$this->outTarget = $out;
}
else {
$this->out = $out;
}
}
}
/**
* Flush buffer, optionally tidy up HTML, and close output if it's not to a php stream
*/
public function flush() {
if ($this->out && strncmp($this->outTarget, 'php://', 6) !== 0) {
fclose($this->out);
}
if ($this->printsHTML === TRUE && $this->outTarget !== NULL && strpos($this->outTarget, 'php://') !== 0 && strpos($this->outTarget, 'socket://') !== 0 && extension_loaded('tidy')) {
file_put_contents($this->outTarget, tidy_repair_file($this->outTarget, array(
'indent' => TRUE,
'wrap' => 0,
), 'utf8'));
}
}
/**
* 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.
*
* @since Method available since Release 3.3.0
*/
public function incrementalFlush() {
if ($this->out) {
fflush($this->out);
}
else {
flush();
}
}
/**
* @param string $buffer
*/
public function write($buffer) {
if ($this->out) {
fwrite($this->out, $buffer);
if ($this->autoFlush) {
$this
->incrementalFlush();
}
}
else {
if (PHP_SAPI != 'cli') {
$buffer = htmlspecialchars($buffer);
}
print $buffer;
if ($this->autoFlush) {
$this
->incrementalFlush();
}
}
}
/**
* Check auto-flush mode.
*
* @return boolean
* @since Method available since Release 3.3.0
*/
public function getAutoFlush() {
return $this->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.
*
* @param boolean $autoFlush
* @since Method available since Release 3.3.0
*/
public function setAutoFlush($autoFlush) {
if (is_bool($autoFlush)) {
$this->autoFlush = $autoFlush;
}
else {
throw PHPUnit_Util_InvalidArgumentHelper::factory(1, 'boolean');
}
}
}
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
PHPUnit_Util_Printer:: |
protected | property | If TRUE, flush output after every write. | |
PHPUnit_Util_Printer:: |
protected | property | ||
PHPUnit_Util_Printer:: |
protected | property | ||
PHPUnit_Util_Printer:: |
protected | property | 1 | |
PHPUnit_Util_Printer:: |
public | function | Flush buffer, optionally tidy up HTML, and close output if it's not to a php stream | 2 |
PHPUnit_Util_Printer:: |
public | function | Check auto-flush mode. | |
PHPUnit_Util_Printer:: |
public | function | Performs a safe, incremental flush. | |
PHPUnit_Util_Printer:: |
public | function | Set auto-flushing mode. | |
PHPUnit_Util_Printer:: |
public | function | 2 | |
PHPUnit_Util_Printer:: |
public | function | Constructor. | 4 |