.
*/
include_once 'phing/system/io/FilterReader.php';
include_once 'phing/system/io/StringReader.php';
/**
* Base class for core filter readers.
*
* @author Yannick Lecaillez
* @version $Revision: 1.8 $ $Date: 2004/05/20 02:24:10 $
* @access public
* @see FilterReader
* @package phing.filters
*/
class BaseFilterReader extends FilterReader {
/** Have the parameters passed been interpreted? */
protected $initialized = false;
/** The Phing project this filter is part of. */
protected $project = null;
/**
* Constructor used by Phing's introspection mechanism.
* The original filter reader is only used for chaining
* purposes, never for filtering purposes (and indeed
* it would be useless for filtering purposes, as it has
* no real data to filter). ChainedReaderHelper uses
* this placeholder instance to create a chain of real filters.
*
* @param Reader $in
*/
function __construct($in = null) {
if ($in === null) {
$dummy = "";
$in = new StringReader($dummy);
}
parent::__construct($in);
}
/**
* Returns the initialized status.
*
* @return boolean whether or not the filter is initialized
*/
function getInitialized() {
return $this->initialized;
}
/**
* Sets the initialized status.
*
* @param boolean $initialized Whether or not the filter is initialized.
*/
function setInitialized($initialized) {
$this->initialized = (boolean) $initialized;
}
/**
* Sets the project to work with.
*
* @param object $project The project this filter is part of.
* Should not be null.
*/
function setProject(Project $project) {
// type check, error must never occur, bad code of it does
$this->project = $project;
}
/**
* Returns the project this filter is part of.
*
* @return object The project this filter is part of
*/
function getProject() {
return $this->project;
}
/**
* Reads characters.
*
* @param off Offset at which to start storing characters.
* @param len Maximum number of characters to read.
*
* @return Characters read, or -1 if the end of the stream
* has been reached
*
* @throws IOException If an I/O error occurs
*/
function read($len = null) {
return $this->in->read($len);
}
/**
* Reads a line of text ending with '\n' (or until the end of the stream).
* The returned String retains the '\n'.
*
* @return the line read, or null if the end of the
stream has already been reached
*
* @throws IOException if the underlying reader throws one during
* reading
*/
function readLine() {
$line = null;
while ( ($ch = $this->in->read(1)) !== -1 ) {
$line .= $ch;
if ( $ch === "\n" )
break;
}
return $line;
}
/**
* Returns whether the end of file has been reached with input stream.
* @return boolean
*/
function eof() {
return $this->in->eof();
}
/**
* Convenience method to support logging in filters.
* @param string $msg Message to log.
* @param int $level Priority level.
*/
function log($msg, $level = PROJECT_MSG_INFO) {
if ($this->project !== null) {
$this->project->log("[filter:".get_class($this)."] ".$msg, $level);
}
}
}
?>