phing-filters

# Class: TabToSpaces Source Location: /filters/TabToSpaces.php
### Class Overview
    Reader
       |
       --FilterReader
          |
          --BaseFilterReader
             |
             --BaseParamFilterReader
                |
                --TabToSpaces
Converts tabs to spaces. #### Author(s): Yannick Lecaillez <yl@seasonfive.com> Hans Lellelid <hans@xmpl.org> #### Version: $Revision: 526 $ #### Copyright: © 2003 seasonfive. All rights reserved Implements interfaces: ChainableReader | ### Constants DEFAULT_TAB_LENGTH TAB_LENGTH_KEY | ### Methods chain getTablength read setTablength
### Inherited Variables #### Class: BaseParamFilterReader BaseParamFilterReader::$_parameters #### Class: BaseFilterReader BaseFilterReader::$initialized BaseFilterReader::$project #### Class: FilterReader FilterReader::$in | ### Inherited Methods #### Class: BaseParamFilterReader BaseParamFilterReader::getParameters() BaseParamFilterReader::setParameters() #### 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 45] Converts tabs to spaces. Example:
Or:
#### Tags:
author: | Yannick Lecaillez <yl@seasonfive.com>
author: | Hans Lellelid <hans@xmpl.org>
version: | $Revision: 526 $
copyright: | © 2003 seasonfive. All rights reserved
see: | BaseParamFilterReader
[ Top ] ### Class Methods ### method chain [line 120]
`Reader chain( $reader)`
Creates a new TabsToSpaces using the passed in Reader for instantiation. #### Tags:
return: | A new filter based on this configuration, but filtering the specified reader
Implementation of: ChainableReader::chain() Returns a reader with the same configuration as this one, but filtering input from the specified reader. #### Parameters:
Reader | $reader | A Reader object providing the underlying stream. Must not be null .
[ Top ] ### method getTablength [line 106]
`int getTablength( )`
Returns the tab length. #### Tags:
return: | The number of spaces used when converting a tab
[ Top ] ### method read [line 74]
`the read( [ $len = null])`
Returns stream after converting tabs to the specified number of spaces. #### Tags:
return: | resulting stream, or -1 if the end of the resulting stream has been reached
exception: | IOException if the underlying stream throws an IOException during reading
Overrides BaseFilterReader::read() (Reads characters.) #### Parameters:
| $len |
[ Top ] ### method setTablength [line 97]
`void setTablength( int $tabLength)`
Sets the tab length. #### Parameters:
int | $tabLength | The number of spaces to be used when converting a tab.
[ Top ] ### Class Constants #### DEFAULT_TAB_LENGTH = 8 [line 51] The default tab length. [ Top ] #### TAB_LENGTH_KEY = "tablength" [line 57] Parameter name for the length of a tab. [ Top ] Documentation generated on Mon, 19 Oct 2009 10:52:10 +0200 by phpDocumentor 1.4.3