phing-system-io
[ class tree: phing-system-io ] [ index: phing-system-io ] [ all elements ]

Class: Writer

Source Location: /system/io/Writer.php

Class Overview


Abstract class for writing character streams.


Author(s):

Methods


Child classes:

LogWriter
Extends the Writer class to output messages to Phing's log
BufferedWriter
Convenience class for writing files.
OutputStreamWriter
Writer class for OutputStream objects.

Class Details

[line 27]
Abstract class for writing character streams.



Tags:

abstract:  


[ Top ]


Class Methods


method close [line 41]

void close( )

Close the stream.



Tags:

abstract:  
throws:  IOException - if there is an error closing stream.
access:  public


Overridden in child classes as:

LogWriter::close()
BufferedWriter::close()
Close attached stream.
OutputStreamWriter::close()
Close the stream.

[ Top ]

method flush [line 46]

void flush( )

Flush the stream, if supported by the stream.



Tags:

access:  public


Overridden in child classes as:

BufferedWriter::flush()
OutputStreamWriter::flush()
Flush output to the stream.

[ Top ]

method getResource [line 52]

string getResource( )

Returns a string representation of resource filename, url, etc. that is being written to.



Tags:

abstract:  
access:  public


Overridden in child classes as:

LogWriter::getResource()
BufferedWriter::getResource()
OutputStreamWriter::getResource()
Gets a string representation of attached stream resource.

[ Top ]

method write [line 35]

void write( string $buf, [int $off = null], [int $len = null])

Writes data to output stream.



Tags:

abstract:  
access:  public


Overridden in child classes as:

LogWriter::write()
BufferedWriter::write()
OutputStreamWriter::write()
Write char data to stream.

Parameters:

string   $buf  
int   $off  
int   $len  

[ Top ]


Documentation generated on Mon, 19 Oct 2009 10:52:23 +0200 by phpDocumentor 1.4.3