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

Class: OutputStream

Source Location: /system/io/OutputStream.php

Class Overview


Wrapper class for PHP stream that supports write operations.


Variables

Methods


Child classes:

FileOutputStream
Output stream subclass for file streams.

Class Details

[line 27]
Wrapper class for PHP stream that supports write operations.



[ Top ]


Class Variables

$stream =

[line 32]



Tags:

var:  The configured PHP stream.
access:  protected

Type:   resource


[ Top ]



Class Methods


constructor __construct [line 38]

OutputStream __construct( resource $stream)

Construct a new OutputStream.



Tags:

access:  public


Overridden in child classes as:

FileOutputStream::__construct()
Construct a new FileOutputStream.

Parameters:

resource   $stream   Configured PHP stream for writing.

[ Top ]

method close [line 50]

void close( )

Closes attached stream, flushing output first.



Tags:

throws:  IOException if cannot close stream (note that attempting to close an already closed stream will not raise an IOException)
access:  public


[ Top ]

method flush [line 67]

void flush( )

Flushes stream.



Tags:

throws:  IOException if unable to flush data (e.g. stream is not open).
access:  public


[ Top ]

method write [line 82]

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

Writes data to stream.



Tags:

throws:  IOException - if there is an error writing to stream
access:  public


Parameters:

string   $buf   Binary/character data to write.
int   $off   (Optional) offset.
int   $len   (Optional) number of bytes/chars to write.

[ Top ]

method __toString [line 104]

string __toString( )

Returns a string representation of the attached PHP stream.



Tags:

access:  public


Overridden in child classes as:

FileOutputStream::__toString()
Returns a string representation of the attached file.

[ Top ]


Documentation generated on Mon, 19 Oct 2009 10:51:20 +0200 by phpDocumentor 1.4.3