phing-filters
[ class tree: phing-filters ] [ index: phing-filters ] [ all elements ]

Class: BaseParamFilterReader

Source Location: /filters/BaseParamFilterReader.php

Class Overview

Reader
   |
   --FilterReader
      |
      --BaseFilterReader
         |
         --BaseParamFilterReader

Base class for core filter readers.


Author(s):

Version:

  • $Revision: 526 $ $Date: 2009-08-11 14:11:17 +0200 (Tue, 11 Aug 2009) $

Copyright:

  • © 2003 seasonfive. All rights reserved

Implements interfaces:

Variables

Methods


Child classes:

XincludeFilter
Applies Xinclude parsing to incoming text.
TailFilter
Reads the last
  1. n
lines of a stream. (Default is last10 lines.)
TranslateGettext
Replaces gettext("message id") and _("message id") with the translated string.
TabToSpaces
Converts tabs to spaces.
LineContainsRegexp
Filter which includes only those lines that contain the user-specified regular expression matching strings.
HeadFilter
Reads the first
  1. n
lines of a stream.
LineContains
Filter which includes only those lines that contain all the user-specified strings.
ReplaceTokensWithFile
Base class for core filter readers.
StripLineComments
This filter strips line comments.
PrefixLines
Attaches a prefix to every line.
StripLineBreaks
Filter to flatten the stream to a single line.
XsltFilter
Applies XSL stylesheet to incoming text.
ReplaceTokens
Replaces tokens in the original input with user-supplied values.
TidyFilter
This filter uses the bundled-with-PHP Tidy extension to filter input.

Inherited Variables

Inherited Methods

Class: BaseFilterReader

BaseFilterReader::__construct()
Constructor used by Phing's introspection mechanism.
BaseFilterReader::eof()
Returns whether the end of file has been reached with input stream.
BaseFilterReader::getInitialized()
Returns the initialized status.
BaseFilterReader::getProject()
Returns the project this filter is part of.
BaseFilterReader::log()
Convenience method to support logging in filters.
BaseFilterReader::read()
Reads characters.
BaseFilterReader::readLine()
Reads a line of text ending with '\n' (or until the end of the stream).
BaseFilterReader::setInitialized()
Sets the initialized status.
BaseFilterReader::setProject()
Sets the project to work with.

Class: FilterReader

FilterReader::__construct()
FilterReader::close()
FilterReader::getResource()
FilterReader::read()
Read data from source.
FilterReader::reset()
FilterReader::setReader()
FilterReader::skip()

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 37]
Base class for core filter readers.



Tags:

author:  <href="mailto:yl@seasonfive.com" a href="mailto:yl@seasonfive.com">Yannick Lecaillez</a>
version:  $Revision: 526 $ $Date: 2009-08-11 14:11:17 +0200 (Tue, 11 Aug 2009) $
copyright:  © 2003 seasonfive. All rights reserved
see:  FilterReader
access:  public


[ Top ]


Class Variables

$_parameters = array()

[line 40]

The passed in parameter array.



Tags:

access:  protected

Type:   mixed


[ Top ]



Class Methods


method getParameters [line 64]

void &getParameters( )



[ Top ]

method setParameters [line 49]

void setParameters( $parameters)




Implementation of:
Parameterizable::setParameters

Parameters:

   $parameters  

[ Top ]


Documentation generated on Mon, 19 Oct 2009 10:50:23 +0200 by phpDocumentor 1.4.3