filters/util/ChainReaderHelper.php

Show: inherited
Table of Contents

\ChainReaderHelper

Package: phing\filters\util

Process a FilterReader chain.

Here, the interesting method is 'getAssembledReader'. The purpose of this one is to create a simple Reader object which apply all filters on another primary Reader object.

For example : In copyFile (phing.util.FileUtils) the primary Reader is a FileReader object (more accuratly, a BufferedReader) previously setted for the source file to copy. So, consider this filterchain :

<filterchain>
   <stripphpcomments />
   <linecontains>
       <contains value="foo">
   </linecontains>
 <tabtospaces tablength="8" />

getAssembledReader will return a Reader object wich read on each of these filters. Something like this : ('->' = 'which read data from') :

[TABTOSPACES] -> [LINECONTAINS] -> [STRIPPHPCOMMENTS] -> [FILEREADER] (primary reader)

So, getAssembledReader will return the TABTOSPACES Reader object. Then each read done with this Reader object will follow this path.

Hope this explanation is clear :)

TODO: Implement the classPath feature.

Access
public  
Author
Yannick Lecaillez  
Version
$Id$  

Properties

Propertyprivate  $bufferSize= '8192'

The site of the buffer to be used.

Default value8192Details
Type
n/a
Propertyprivate  $filterChains= 'array()'

Chain of filters

Default valuearray()Details
Type
n/a
Propertyprivate  $primaryReader= 'null'

Primary reader to wich the reader chain is to be attached

Default valuenullDetails
Type
n/a
Propertyprivate  $project= ''

The Phing project

Details
Type
n/a

Methods

methodpublicgetAssembledReader( ) : void

methodpublicgetProject( ) : void

methodpublicsetBufferSize(  $size ) : void

Parameters
Name Type Description
$size
methodpublicsetFilterChains(  $fchain ) : void

Parameters
Name Type Description
$fchain
methodpublicsetPrimaryReader(  $reader ) : void

Parameters
Name Type Description
$reader
methodpublicsetProject(  $project ) : void

Parameters
Name Type Description
$project
Documentation was generated by DocBlox 0.18.1.