. */ include_once 'phing/filters/BaseParamFilterReader.php'; include_once 'phing/filters/ChainableReader.php'; /** * Attaches a prefix to every line. * * Example: *
* * Or: * *
* * @author Yannick Lecaillez * @author hans lellelid, hans@velum.net * @version $Revision: 1.6 $ $Date: 2004/03/15 14:45:06 $ * @access public * @see FilterReader * @package phing.filters */ class PrefixLines extends BaseParamFilterReader implements ChainableReader { /** * Parameter name for the prefix. * @var string */ const PREFIX_KEY = "lines"; /** * The prefix to be used. * @var string */ private $_prefix = null; /** * Adds a prefix to each line of input stream and returns resulting stream. * * @return mixed buffer, -1 on EOF */ function read($len = null) { if ( !$this->getInitialized() ) { $this->_initialize(); $this->setInitialized(true); } $buffer = $this->in->read($len); if ($buffer === -1) { return -1; } $lines = explode("\n", $buffer); $filtered = array(); foreach($lines as $line) { $line = $this->_prefix . $line; $filtered[] = $line; } $filtered_buffer = implode("\n", $filtered); return $filtered_buffer; } /** * Sets the prefix to add at the start of each input line. * * @param string $prefix The prefix to add at the start of each input line. * May be* *
null
, in which case no prefix
* is added.
*/
function setPrefix($prefix) {
$this->_prefix = (string) $prefix;
}
/**
* Returns the prefix which will be added at the start of each input line.
*
* @return string The prefix which will be added at the start of each input line
*/
function getPrefix() {
return $this->_prefix;
}
/**
* Creates a new PrefixLines filter using the passed in
* Reader for instantiation.
*
* @param object A Reader object providing the underlying stream.
* Must not be null
.
*
* @return object A new filter based on this configuration, but filtering
* the specified reader
*/
function chain(Reader $reader) {
$newFilter = new PrefixLines($reader);
$newFilter->setPrefix($this->getPrefix());
$newFilter->setInitialized(true);
$newFilter->setProject($this->getProject());
return $newFilter;
}
/**
* Initializes the prefix if it is available from the parameters.
*/
private function _initialize() {
$params = $this->getParameters();
if ( $params !== null ) {
for($i = 0, $_i=count($params) ; $i < $_i ; $i++) {
if ( self::PREFIX_KEY == $params[$i]->getName() ) {
$this->_prefix = (string) $params[$i]->getValue();
break;
}
}
}
}
}
?>