Index

  1. \SetaPDF
    1. Core
    2. Core
      1. Writer
      2. Writer
        1. AbstractWriter
        2. Binary
        3. Chain
        4. CopyStreamInterface
        5. Echo
        6. Exception
        7. File
        8. FileInterface
        9. Http
        10. HttpStream
        11. Stream
        12. String
        13. TempFile
        14. TempStream
        15. Var
        16. WriterInterface

SetaPDF_Core_Writer_TempStream A writer class for temporary streams

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

Class hierarchy

Implements

Summary

Methods

Properties

Properties

$_buffer

protected string SetaPDF_Core_Writer_TempStream::$_buffer = ''

$_bufferSize

protected int SetaPDF_Core_Writer_TempStream::$_bufferSize = 10000

$_handle

protected resource SetaPDF_Core_Writer_Stream::$_handle

The file stream resource

$_status

protected string SetaPDF_Core_Writer_AbstractWriter::$_status = 0

Status property


Methods

__construct()

public SetaPDF_Core_Writer_TempStream::__construct (
[ null|int $memoryLimit = null [, int $bufferSize = 10000 ]]
)

The constructor.

Parameters
$memoryLimit : null|int

Limit to use before writing to a temporary file. If null PHPs default (2 MB) is used.

$bufferSize : int

The buffer size of which needs to be reached until the data is written to the stream.

__destruct()

public SetaPDF_Core_Writer_TempStream::__destruct (
void
): void

The deconstructor closes the file handle.

_flush()

protected SetaPDF_Core_Writer_TempStream::_flush (
void
): void

Flushes the buffer to the stream and resets the buffer.

_setHandle()

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

Set the stream handle.

Parameters
$handle : resource
 

cleanUp()

public SetaPDF_Core_Writer_AbstractWriter::cleanUp (
void
): void

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

copy()

WARNING: This method is marked as deprecated!

Use copyStream() instead.

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

copyStream()

public SetaPDF_Core_Writer_Stream::copyStream (
resource|SetaPDF_Core_Writer_Stream $source
): void

Copies an existing stream into the target stream.

Parameters
$source : resource|SetaPDF_Core_Writer_Stream
 

finish()

public SetaPDF_Core_Writer_TempStream::finish (
void
): void

Finish methods flushes the buffer to the stream.

getHandle()

public SetaPDF_Core_Writer_TempStream::getHandle (
void
): resource

Gets the handle of the stream.

This method is overwritten to ensure that the handle is only accessed when the writer instance has the status "finished".

getPos()

public SetaPDF_Core_Writer_TempStream::getPos (
void
): integer

Returns the current position.

getStatus()

public SetaPDF_Core_Writer_AbstractWriter::getStatus (
void
): string

Get the current status of the writer object.

start()

public SetaPDF_Core_Writer_AbstractWriter::start (
void
): void

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

write()

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

Write content to the stream or buffer.

Parameters
$s : string
 

© 2024 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)