Index

  1. \setasign\SetaPDF2
    1. Core
      1. Writer
        1. AbstractWriter
        2. BinaryWriter
        3. ChainWriter
        4. CopyStreamInterface
        5. EchoWriter
        6. Exception
        7. FileInterface
        8. FileWriter
        9. HttpStreamWriter
        10. HttpWriter
        11. StreamWriter
        12. StringWriter
        13. TempFileWriter
        14. TempStreamWriter
        15. VarWriter
        16. WriteInterface
        17. Writer
        18. WriterInterface

setasign\SetaPDF2\Core\Writer

WriterInterface The writer interface

File: /SetaPDF v2/Core/Writer/WriterInterface.php
Old class name (alias): \SetaPDF_Core_Writer_WriterInterface

Implemented in

Implements

Summary

Methods

Methods

cleanUp()

abstract public WriterInterface::cleanUp (
void
): void

Method called if a documents cleanUp-method is called.

finish()

abstract public WriterInterface::finish (
void
): void

This method is called when the writing process is finished.

It could close a file handle for example or send headers and flush a buffer.

getPos()

abstract public WriterInterface::getPos (
void
): int

Gets the current position/offset.

getStatus()

abstract public WriterInterface::getStatus (
void
): int

Get the current writer status.

See

start()

abstract public WriterInterface::start (
void
): void

Method called when the writing process starts.

This method could send for example headers.

write()

abstract public WriteInterface::write (
string $bytes
): void

Writes bytes to the output.

Parameters
$bytes : string
 

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