SetaPDF_Core_Writer_Stream A writer class for streams

File: /SetaPDF v2/Core/Writer/Stream.php

Class hierarchy

Implements

Summary

Properties

$_handle

protected null|resource SetaPDF_Core_Writer_Stream::$_handle

The file stream resource

$_status

Status property


Methods

__construct()

public SetaPDF_Core_Writer_Stream::__construct (
resource $handle
)

The constructor.

Parameters
$handle : resource
 

_setHandle()

protected SetaPDF_Core_Writer_Stream::_setHandle (
resource $handle
): void

Set the stream handle.

Parameters
$handle : resource
 

cleanUp()

Method which should/will be called when the document objects cleanUp() method is called.

copy()

public SetaPDF_Core_Writer_Stream::copy (
resource $source
): void

Copies an existing stream into the target stream.

Parameters
$source : resource
 

finish()

Method which should/will be called when the writing process is finished.

getHandle()

public SetaPDF_Core_Writer_Stream::getHandle (
void
): resource

Get the stream handle.

getPos()

public SetaPDF_Core_Writer_Stream::getPos (
void
): integer

Returns the current position of the output file.

getStatus()

Get the current status of the writer object.

start()

Method which should/will be called when the writing process starts.

write()

public SetaPDF_Core_Writer_Stream::write (
string $s
): void

Write the content to the output file.

Parameters
$s : string