phing-system-io
[ class tree: phing-system-io ] [ index: phing-system-io ] [ all elements ]

Class: FilterReader

Source Location: /system/io/FilterReader.php

Class Overview

Reader
   |
   --FilterReader

Wrapper class for readers, which can be used to apply filters.


Author(s):

Version:

  • $Revision: 552 $

Variables

Methods


Child classes:

BaseFilterReader
Base class for core filter readers.

Inherited Methods

Class: Reader

Reader::close()
Close stream.
Reader::getResource()
Returns the filename, url, etc. that is being read from.
Reader::mark()
If supported, places a "marker" (like a bookmark) at current stream position.
Reader::markSupported()
Whether marking is supported.
Reader::read()
Read data from source.
Reader::ready()
Is stream ready for reading.
Reader::reset()
Reset the current position in stream to beginning or last mark (if supported).
Reader::skip()
Move stream position relative to current pos.

Class Details

[line 28]
Wrapper class for readers, which can be used to apply filters.



Tags:

author:  Yannick Lecaillez <yl@seasonfive.com>
author:  Hans Lellelid <hans@xmpl.org>
version:  $Revision: 552 $


[ Top ]


Class Variables

$in =

[line 33]



Tags:

access:  protected

Type:   Reader


[ Top ]



Class Methods


constructor __construct [line 35]

FilterReader __construct( [Reader $in = null])



Overridden in child classes as:

BaseFilterReader::__construct()
Constructor used by Phing's introspection mechanism.

Parameters:

Reader   $in  

[ Top ]

method close [line 60]

void close( )



Tags:

access:  public


Overrides Reader::close() (Close stream.)

[ Top ]

method getResource [line 64]

void getResource( )



Overrides Reader::getResource() (Returns the filename, url, etc. that is being read from.)

[ Top ]

method read [line 52]

void read( [ $len = null])

Read data from source.

FIXME: Clean up this function signature, as it a) params aren't being used and b) it doesn't make much sense.




Tags:

access:  public


Overridden in child classes as:

BaseFilterReader::read()
Reads characters.
StripPhpComments::read()
Returns the stream without Php comments.
ExpandProperties::read()
Returns the filtered stream.
XincludeFilter::read()
Reads stream, applies XSLT and returns resulting stream.
TailFilter::read()
Returns the last n lines of a file.
TranslateGettext::read()
Returns the filtered stream.
TabToSpaces::read()
Returns stream after converting tabs to the specified number of spaces.
LineContainsRegexp::read()
Returns all lines in a buffer that contain specified strings.
HeadFilter::read()
Returns first n lines of stream.
LineContains::read()
Returns all lines in a buffer that contain specified strings.
ReplaceTokensWithFile::read()
Returns stream with tokens having been replaced with appropriate values.
StripLineComments::read()
Returns stream only including lines from the original stream which don't start with any of the specified comment prefixes.
PrefixLines::read()
Adds a prefix to each line of input stream and returns resulting stream.
StripLineBreaks::read()
Returns the filtered stream, only including characters not in the set of line-breaking characters.
XsltFilter::read()
Reads stream, applies XSLT and returns resulting stream.
ReplaceTokens::read()
Returns stream with tokens having been replaced with appropriate values.
TidyFilter::read()
Reads input and returns Tidy-filtered output.
StripWhitespace::read()
Returns the stream without Php comments and whitespace.
ReplaceRegexp::read()
Returns the filtered stream.

Overrides Reader::read() (Read data from source.)

Parameters:

   $len  

[ Top ]

method reset [line 56]

void reset( )



Tags:

access:  public


Overrides Reader::reset() (Reset the current position in stream to beginning or last mark (if supported).)

[ Top ]

method setReader [line 39]

void setReader( Reader $in)



Tags:

access:  public


Parameters:

Reader   $in  

[ Top ]

method skip [line 43]

void skip( $n)



Tags:

access:  public


Overrides Reader::skip() (Move stream position relative to current pos.)

Parameters:

   $n  

[ Top ]


Documentation generated on Mon, 19 Oct 2009 10:51:00 +0200 by phpDocumentor 1.4.3