# filters/util/ChainReaderHelper.php

## \ChainReaderHelper
jump to top

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
  $Revision: 526 $ $Date: 2009-08-11 14:11:17 +0200 (Tue, 11 Aug 2009) $

### Properties

`$bufferSize= '8192'`

The site of the buffer to be used.

Default value `8192` Details

Type
  n/a

`$filterChains= 'array()'`

Chain of filters

Default value `array()`Details

Type
  n/a

`$primaryReader= 'null'`

Primary reader to wich the reader chain is to be attached

Default value `null` Details

Type
  n/a

`$project= ''`

The Phing project

Details

Type
  n/a

### Methods

`getAssembledReader( ) : void`

`getProject( ) : void`

`setBufferSize( $size ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$size |  |

`setFilterChains( $fchain ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$fchain |  |

`setPrimaryReader( $reader ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$reader |  |

`setProject( $project ) : void`

Parameters

Name | Type | Description
--- | --- | ---
$project |  |

Documentation was generated by DocBlox 0.17.1.