phing-system-io

# Class: FileReader Source Location: /system/io/FileReader.php
### Class Overview
    Reader
       |
       --InputStreamReader
          |
          --FileReader
Convenience class for reading files. #### Author(s): Yannick Lecaillez <yl@seasonfive.com> Hans Lellelid <hans@xmpl.org> #### Version: $Revision: 552 $ | ### Methods __construct
### Inherited Variables #### Class: InputStreamReader InputStreamReader::$inStream | ### Inherited Methods #### Class: InputStreamReader InputStreamReader::__construct() Construct a new InputStreamReader. InputStreamReader::close() Close the stream. InputStreamReader::eof() Whether eof has been reached with stream. InputStreamReader::getResource() Returns string representation of attached stream. InputStreamReader::mark() Marks the current position in this input stream. InputStreamReader::markSupported() Whether the attached stream supports mark/reset. InputStreamReader::read() Read data from file. InputStreamReader::readInto() Reads a entire file and stores the data in the variable passed by reference. InputStreamReader::reset() Repositions this stream to the position at the time the mark method was last called on this input stream. InputStreamReader::skip() Skip over $n bytes. #### 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 29] Convenience class for reading files. #### Tags:
author: | Yannick Lecaillez <yl@seasonfive.com>
author: | Hans Lellelid <hans@xmpl.org>
version: | $Revision: 552 $
[ Top ] ### Class Methods ### constructor __construct [line 35]
`FileReader __construct( mixed $file)`
Construct a new FileReader. #### Tags:
access: | public
Overrides InputStreamReader::__construct() (Construct a new InputStreamReader.) #### Parameters:
mixed | $file | PhingFile or string pathname.
[ Top ] Documentation generated on Mon, 19 Oct 2009 10:50:56 +0200 by phpDocumentor 1.4.3