filters/ExpandProperties.php
Expands Phing Properties, if any, in the data.
<
p>
Example:
Or:
Author Yannick Lecaillez Author Hans Lellelid Package phing.filters See \BaseFilterReader Version $Id: d6bb7717db7cf2b122cbdcb93e5bb0f45d97ec52 $ \ExpandProperties
Package: phing\filtersDocumentation was generated by DocBlox 0.18.1.Expands Phing Properties, if any, in the data.
<
p> Example:
Or:
Parent(s) \BaseFilterReader < \FilterReader < \Reader See \BaseFilterReader Author Yannick Lecaillez Author Hans Lellelid Version $Id: d6bb7717db7cf2b122cbdcb93e5bb0f45d97ec52 $ Properties
\Reader $in= ''
Details
- Type
- \Reader
- Inherited_from
- \FilterReader::$$in
- Inherited_from
- \BaseFilterReader::$$in
$initialized= 'false'
inheritedHave the parameters passed been interpreted?
Inherited from: \BaseFilterReader::$$initializedDefault valuefalse
Details
- Type
- n/a
- Inherited_from
- \BaseFilterReader::$$initialized
Methods
__construct( \Reader $in = null ) : void
inheritedConstructor used by Phing's introspection mechanism.
Inherited from: \BaseFilterReader::__construct()ParametersThe 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.
Name Type Description $in \Reader
chain( object $reader ) : object
Creates a new ExpandProperties filter using the passed in Reader for instantiation.
ParametersReturns
Name Type Description $reader object A Reader object providing the underlying stream. Must not be
null
.
Type Description object A new filter based on this configuration, but filtering the specified reader
eof( ) : boolean
inheritedReturns whether the end of file has been reached with input stream.
Inherited from: \BaseFilterReader::eof()Returns
Type Description boolean
getInitialized( ) : boolean
Returns
Type Description boolean whether or not the filter is initialized
getProject( ) : object
inheritedReturns the project this filter is part of.
Inherited from: \BaseFilterReader::getProject()Returns
Type Description object The project this filter is part of
getResource( ) : string
inheritedReturns the filename, url, etc. that is being read from.
Inherited from: \FilterReader::getResource()\BaseFilterReader::getResource()ReturnsThis is critical for, e.g., ExpatParser's ability to know the filename that is throwing an ExpatParserException, etc.
Type Description string
log( string $msg, int $level = Project::MSG_INFO ) : void
Parameters
Name Type Description $msg string Message to log.
$level int Priority level.
mark( ) : void
inheritedIf supported, places a "marker" (like a bookmark) at current stream position.
Inherited from: \Reader::mark()\FilterReader::mark()\BaseFilterReader::mark()A subsequent call to reset() will move stream position back to last marker (if supported).
markSupported( ) : boolean
inheritedWhether marking is supported.
Inherited from: \Reader::markSupported()\FilterReader::markSupported()\BaseFilterReader::markSupported()Returns
Type Description boolean
read( \off $len = null ) : mixed
Returns the filtered stream.
ParametersThe original stream is first read in fully, and the Phing properties are expanded.
Returns
Name Type Description $len \off Offset at which to start storing characters.
Throws
Type Description mixed the filtered stream, or -1 if the end of the resulting stream has been reached. Details
Exception Description \IOException If an I/O error occurs
- Exception
- IOException if the underlying stream throws an IOException during reading
readLine( ) : \the
inheritedReads a line of text ending with '\n' (or until the end of the stream).
Inherited from: \BaseFilterReader::readLine()ReturnsThe returned String retains the '\n'.
Throws
Type Description \the line read, or <code>null</code> if the end of the stream has already been reached
Exception Description \IOException if the underlying reader throws one during reading
ready( ) : boolean
inheritedIs stream ready for reading.
Inherited from: \Reader::ready()\FilterReader::ready()\BaseFilterReader::ready()Returns
Type Description boolean
reset( ) : void
inheritedReset the current position in stream to beginning or last mark (if supported).
Inherited from: \FilterReader::reset()\BaseFilterReader::reset()
setInitialized( boolean $initialized ) : void
Parameters
Name Type Description $initialized boolean Whether or not the filter is initialized.
setLevel( string $level ) : void
Set level of log messages generated (default = info)
Parameters
Name Type Description $level string
setProject( object $project ) : void
Parameters
Name Type Description $project object The project this filter is part of. Should not be
null
.
skip( int $n ) : void
inheritedMove stream position relative to current pos.
Inherited from: \FilterReader::skip()\BaseFilterReader::skip()Parameters
Name Type Description $n int