system/io/StringReader.php
inherited
Classes
Dummy class for reading from string of characters.
- Package
- phing.system.io
\StringReader
Dummy class for reading from string of characters.
- Parent(s)
- \Reader
- Author
- Hans Lellelid
- Author
- Yannick Lecaillez
- Version
- $Id$
Properties
string
$_string= ''
- Type
- string
int
$currPos= '0'
0Details- Type
- int
int
$mark= '0'
0Details- Type
- int
Methods
__construct(
$string
)
:
void| Name | Type | Description |
|---|---|---|
| $string |
close(
)
:
voidClose stream.
| Exception | Description |
|---|---|
| \IOException | if there is an error closing stream |
getResource(
)
:
stringReturns the filename, url, etc. that is being read from.
This is critical for, e.g., ExpatParser's ability to know the filename that is throwing an ExpatParserException, etc.
| Type | Description |
|---|---|
| string |
mark(
)
:
voidIf supported, places a "marker" (like a bookmark) at current stream position.
A subsequent call to reset() will move stream position back to last marker (if supported).
markSupported(
)
:
booleanWhether marking is supported.
| Type | Description |
|---|---|
| boolean |
open(
)
:
voidread(
int $len
=
null
)
:
voidRead data from source.
If length is specified, then only that number of chars is read, otherwise stream is read until EOF.
| Name | Type | Description |
|---|---|---|
| $len | int |
ready(
)
:
booleanIs stream ready for reading.
| Type | Description |
|---|---|
| boolean |
reset(
)
:
voidReset the current position in stream to beginning or last mark (if supported).
skip(
int $n
)
:
voidMove stream position relative to current pos.
| Name | Type | Description |
|---|---|---|
| $n | int |