# filters/ExpandProperties.php

## \ExpandProperties
jump to top

Package: phing\filters

Expands Phing Properties, if any, in the data.

<

p> Example:

Or:

###

###

    Implements
    \ChainableReader
    Parent(s)

    \BaseFilterReader
                <
                \FilterReader
                <
                \Reader

    See

    \BaseFilterReader

    Author

    Yannick Lecaillez

    Author

    Hans Lellelid

    Version
    $Revision: 526 $

    Properties

    \Reader
                     $in= ''

    inheritedInherited from:
                            \FilterReader::$in

    Details
    Type
    \Reader
    Inherited_from

    \FilterReader::$in

                     $initialized= 'false'

    inheritedHave the parameters passed been interpreted?
    Inherited from:
                            \BaseFilterReader::$initialized

    Default valuefalseDetails
    Type

    Inherited_from

    \BaseFilterReader::$initialized

                     $project= 'null'

    inheritedThe Phing project this filter is part of.
    Inherited from:
                            \BaseFilterReader::$project

    Default valuenullDetails
    Type

    Inherited_from

    \BaseFilterReader::$project

    Methods

    __construct(
              \Reader $in
                  =
                  null
              )

            :
              void
    inheritedConstructor used by Phing's introspection mechanism.
    Inherited from:
                        \BaseFilterReader::__construct()

    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.

    Parameters

    Name
    Type
    Description

    $in
    \Reader

    chain(
              object $reader
              )

            :
              objectCreates a new ExpandProperties filter using the passed in
    Reader for instantiation.

    Parameters

    Name
    Type
    Description

    $reader
    object
    A Reader object providing the underlying stream. Must not be null.

    Returns

    Type
    Description

    object
    A new filter based on this configuration, but filtering the specified reader

    close(

              )

            :
              void
    inheritedClose stream.
    Inherited from:
                        \FilterReader::close()

    Throws

    Exception
    Description

    \IOException
    if there is an error closing stream

    eof(

              )

            :
              boolean
    inheritedReturns whether the end of file has been reached with input stream.
    Inherited from:
                        \BaseFilterReader::eof()

    Returns

    Type
    Description

    boolean

    getInitialized(

              )

            :
              boolean
    inheritedReturns the initialized status.
    Inherited from:
                        \BaseFilterReader::getInitialized()

    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()

    This is critical for, e.g., ExpatParser's ability to know
    the filename that is throwing an ExpatParserException, etc.

    Returns

    Type
    Description

    string

    log(
              string $msg, int $level
                  =
                  Project::MSG_INFO
              )

            :
              void
    inheritedConvenience method to support logging in filters.
    Inherited from:
                        \BaseFilterReader::log()

    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()

    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()

    Returns

    Type
    Description

    boolean

    read(
              \off $len
                  =
                  null
              )

            :
              mixedReturns the filtered stream.

    The original stream is first read in fully, and the Phing properties are expanded.

    Parameters

    Name
    Type
    Description

    $len
    \off
    Offset at which to start storing characters.

    Returns

    Type
    Description

    mixed
    the filtered stream, or -1 if the end of the resulting stream has been reached.

    Throws

    Exception
    Description

    \IOException
    If an I/O error occurs

    Details
    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()

    The returned String retains the '\n'.

    Returns

    Type
    Description

    \the
    line read, or <code>null</code> if the end of the stream has already been reached

    Throws

    Exception
    Description

    \IOException
    if the underlying reader throws one during reading

    ready(

              )

            :
              boolean
    inheritedIs stream ready for reading.
    Inherited from:
                        \Reader::ready()

    Returns

    Type
    Description

    boolean

    reset(

              )

            :
              void
    inheritedReset the current position in stream to beginning or last mark (if supported).
    Inherited from:
                        \FilterReader::reset()

    setInitialized(
              boolean $initialized
              )

            :
              void
    inheritedSets the initialized status.
    Inherited from:
                        \BaseFilterReader::setInitialized()

    Parameters

    Name
    Type
    Description

    $initialized
    boolean
    Whether or not the filter is initialized.

    setProject(
              object $project
              )

            :
              void
    inheritedSets the project to work with.
    Inherited from:
                        \BaseFilterReader::setProject()

    Parameters

    Name
    Type
    Description

    $project
    object
    The project this filter is part of. Should not be null.

    setReader(
               $in
              )

            :
              void
    inherited
    Inherited from:
                        \FilterReader::setReader()

    Parameters

    Name
    Type
    Description

    $in

    skip(
              int $n
              )

            :
              void
    inheritedMove stream position relative to current pos.
    Inherited from:
                        \FilterReader::skip()

    Parameters

    Name
    Type
    Description

    $n
    int

Documentation was generated by DocBlox 0.15.1.