phing-system-io

# Class: FileInputStream Source Location: /system/io/FileInputStream.php
### Class Overview
    InputStream
       |
       --FileInputStream
Input stream subclass for file streams. | ### Variables $file | ### Methods __construct markSupported __toString
### Inherited Variables #### Class: InputStream InputStream::$currentPosition InputStream::$mark InputStream::$stream | ### Inherited Methods #### Class: InputStream InputStream::__construct() Construct a new InputStream. InputStream::close() Closes stream. InputStream::eof() Whether eof has been reached with stream. InputStream::mark() Marks the current position in this input stream. InputStream::markSupported() Whether the input stream supports mark and reset methods. InputStream::read() Read data from stream until $len chars or EOF. InputStream::readInto() Reads a entire until EOF and places contents in passed-in variable. Stream is closed after read. InputStream::reset() Repositions this stream to the position at the time the mark method was last called on this input stream. InputStream::skip() Skip over $n bytes. InputStream::__toString() Returns string representation of attached stream.
### Class Details [line 30] Input stream subclass for file streams. [ Top ] ### Class Variables #### $file = [line 35] #### Tags:
var: | The associated file.
access: | protected
Type: | PhingFile
[ Top ] ### Class Methods ### constructor __construct [line 43]
`FileInputStream __construct( mixed $file, [ $append = false])`
Construct a new FileInputStream. #### Tags:
throws: | IOException - if unable to open file.
throws: | Exception - if invalid argument specified.
access: | public
Overrides InputStream::__construct() (Construct a new InputStream.) #### Parameters:
mixed | $file |
| $append |
[ Top ] ### method markSupported [line 72]
`boolean markSupported( )`
Mark is supported by FileInputStream. #### Tags:
return: | TRUE
access: | public
Overrides InputStream::markSupported() (Whether the input stream supports mark and reset methods.) [ Top ] ### method __toString [line 64]
`string __toString( )`
Returns a string representation of the attached file. #### Tags:
access: | public
Overrides InputStream::__toString() (Returns string representation of attached stream.) [ Top ] Documentation generated on Mon, 19 Oct 2009 10:50:54 +0200 by phpDocumentor 1.4.3