system/io/FileOutputStream.php

Show: inherited
Table of Contents

Output stream subclass for file streams.

Package
phing.system.io  

\FileOutputStream

Package: phing\system\io

Output stream subclass for file streams.

Parent(s)
\OutputStream

Properties

Propertyprotected\PhingFile  $file= ''

The associated file.
Details
Type
\PhingFile
Propertyprotectedresource  $stream= ''
inherited

The configured PHP stream.Inherited from: \OutputStream::$$stream
Details
Type
resource
Inherited_from
\OutputStream::$$stream  

Methods

methodpublic__construct( mixed $file, boolean $append = false ) : void

Construct a new FileOutputStream.

Parameters
Name Type Description
$file mixed
$append boolean

Whether to append bytes to end of file rather than beginning.

Throws
Exception Description
\Exception - if invalid argument specified.
\IOException - if unable to open file.
methodpublic__toString( ) : string

Returns a string representation of the attached file.

Returns
Type Description
string
methodpublicclose( ) : void
inherited

Closes attached stream, flushing output first.

Inherited from: \OutputStream::close()
Throws
Exception Description
\IOException if cannot close stream (note that attempting to close an already closed stream will not raise an IOException)
methodpublicflush( ) : void
inherited

Flushes stream.

Inherited from: \OutputStream::flush()
Throws
Exception Description
\IOException if unable to flush data (e.g. stream is not open).
methodpublicwrite( string $buf, int $off = null, int $len = null ) : void
inherited

Writes data to stream.

Inherited from: \OutputStream::write()
Parameters
Name Type Description
$buf string

Binary/character data to write.

$off int

(Optional) offset.

$len int

(Optional) number of bytes/chars to write.

Throws
Exception Description
\IOException - if there is an error writing to stream
Documentation was generated by DocBlox 0.18.1.