filters/TabToSpaces.php
inherited
Classes
\TabToSpaces
Converts tabs to spaces.
Example:
Or:
- Implements
- \ChainableReader
- Parent(s)
- \BaseParamFilterReader < \BaseFilterReader < \FilterReader < \Reader
- See
- \BaseParamFilterReader
- Author
- Yannick Lecaillez
- Author
- Hans Lellelid
- Copyright
- © 2003 seasonfive. All rights reserved
- Version
- $Revision: 526 $
Constants
int
DEFAULT_TAB_LENGTH
= 8The default tab length.
- int
string
TAB_LENGTH_KEY
= "tablength"Parameter name for the length of a tab.
- string
Properties
$_parameters= 'array()'
array()Details- Type
- n/a
- Inherited_from
- \BaseParamFilterReader::$$_parameters
$initialized= 'false'
Have the parameters passed been interpreted?
Inherited from: \BaseFilterReader::$$initialized\BaseParamFilterReader::$$initializedfalseDetails- Type
- n/a
- Inherited_from
- \BaseFilterReader::$$initialized
- Inherited_from
- \BaseParamFilterReader::$$initialized
$project= 'null'
The Phing project this filter is part of.
Inherited from: \BaseFilterReader::$$project\BaseParamFilterReader::$$projectnullDetails- Type
- n/a
- Inherited_from
- \BaseFilterReader::$$project
- Inherited_from
- \BaseParamFilterReader::$$project
int
$tabLength= '8'
Tab length in this filter.
8Details- Type
- int
Methods
__construct(
\Reader $in
=
null
)
:
voidConstructor used by Phing's introspection mechanism.
Inherited from: \BaseFilterReader::__construct()\BaseParamFilterReader::__construct()The original filter reader is only used for chaining purposes, never for filtering purposes (and indeed it would be useless for filtering purposes, as it has no real data to filter). ChainedReaderHelper uses this placeholder instance to create a chain of real filters.
| Name | Type | Description |
|---|---|---|
| $in | \Reader |
_initialize(
)
:
voidParses the parameters to set the tab length.
chain(
\Reader $reader
)
:
\ReaderCreates a new TabsToSpaces using the passed in Reader for instantiation.
close(
)
:
voideof(
)
:
booleanReturns whether the end of file has been reached with input stream.
Inherited from: \BaseFilterReader::eof()\BaseParamFilterReader::eof()| Type | Description |
|---|---|
| boolean |
getInitialized(
)
:
booleanReturns the initialized status.
Inherited from: \BaseFilterReader::getInitialized()\BaseParamFilterReader::getInitialized()| Type | Description |
|---|---|
| boolean | whether or not the filter is initialized |
getProject(
)
:
objectReturns the project this filter is part of.
Inherited from: \BaseFilterReader::getProject()\BaseParamFilterReader::getProject()| Type | Description |
|---|---|
| object | The project this filter is part of |
getResource(
)
:
voidgetTablength(
)
:
intReturns the tab length.
| Type | Description |
|---|---|
| int | The number of spaces used when converting a tab |
log(
string $msg, int $level
=
Project::MSG_INFO
)
:
voidConvenience method to support logging in filters.
Inherited from: \BaseFilterReader::log()\BaseParamFilterReader::log()| Name | Type | Description |
|---|---|---|
| $msg | string | Message to log. |
| $level | int | Priority level. |
mark(
)
:
void
markSupported(
)
:
voidread(
\off $len
=
null
)
:
\theReturns stream after converting tabs to the specified number of spaces.
| Name | Type | Description |
|---|---|---|
| $len | \off | Offset at which to start storing characters. |
| Type | Description |
|---|---|
| \the | resulting stream, or -1 if the end of the resulting stream has been reached |
| Exception | Description |
|---|---|
| \IOException | If an I/O error occurs |
- Exception
- IOException if the underlying stream throws an IOException during reading
readLine(
)
:
\theReads a line of text ending with '\n' (or until the end of the stream).
Inherited from: \BaseFilterReader::readLine()\BaseParamFilterReader::readLine()The returned String retains the '\n'.
| Type | Description |
|---|---|
| \the | line read, or <code>null</code> if the end of the stream has already been reached |
| Exception | Description |
|---|---|
| \IOException | if the underlying reader throws one during reading |
ready(
)
:
void
reset(
)
:
voidsetInitialized(
boolean $initialized
)
:
voidSets the initialized status.
Inherited from: \BaseFilterReader::setInitialized()\BaseParamFilterReader::setInitialized()| Name | Type | Description |
|---|---|---|
| $initialized | boolean | Whether or not the filter is initialized. |
setParameters(
$parameters
)
:
void| Name | Type | Description |
|---|---|---|
| $parameters |
setProject(
object $project
)
:
voidSets the project to work with.
Inherited from: \BaseFilterReader::setProject()\BaseParamFilterReader::setProject()| Name | Type | Description |
|---|---|---|
| $project | object | The project this filter is part of. Should not be |
setReader(
)
:
voidsetTablength(
int $tabLength
)
:
voidSets the tab length.
| Name | Type | Description |
|---|---|---|
| $tabLength | int | The number of spaces to be used when converting a tab. |
skip(
)
:
void