phing-system-io

# Class: ConsoleReader Source Location: /system/io/ConsoleReader.php
### Class Overview
    Reader
       |
       --ConsoleReader
Convenience class for reading console input. #### Author(s): Matthew Hershberger <matthewh@lightsp.com> Hans Lellelid <hans@xmpl.org> #### Version: $Revision: 552 $ | ### Methods close eof getResource open read readLine
### Inherited Methods #### 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 32] Convenience class for reading console input. #### Tags:
author: | Matthew Hershberger <matthewh@lightsp.com>
author: | Hans Lellelid <hans@xmpl.org>
version: | $Revision: 552 $
[ Top ] ### Class Methods ### method close [line 60]
`void close( )`
Overrides Reader::close() (Close stream.) [ Top ] ### method eof [line 72]
`boolean eof( )`
Whether eof has been reached with stream. [ Top ] ### method getResource [line 80]
`string getResource( )`
Returns path to file we are reading. Overrides Reader::getResource() (Returns the filename, url, etc. that is being read from.) [ Top ] ### method open [line 64]
`void open( )`
[ Top ] ### method read [line 47]
`string read( [int $len = null])`
#### Tags:
return: | chars read or -1 if eof.
Overrides Reader::read() (Read data from source.) #### Parameters:
int | $len | Num chars to read.
[ Top ] ### method readLine [line 34]
`void readLine( )`
[ Top ] Documentation generated on Mon, 19 Oct 2009 10:50:35 +0200 by phpDocumentor 1.4.3