SetaPDF v2 API Reference

Index

\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_HttpStream A writer class for immediately HTTP delivery without sending a Length header

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

Class hierarchy

SetaPDF_Core_Writer_AbstractWriter
- SetaPDF_Core_Writer_Echo
  - SetaPDF_Core_Writer_HttpStream

Implements

Summary

Methods

__construct()
cleanUp()
finish()
getPos()
getStatus()
start()
write()

Properties

$_filename
$_inline
$_pos
$_status

Properties

$_filename

protected string SetaPDF_Core_Writer_HttpStream::$_filename = 'document.pdf'

The document filename

$_inline

protected bool SetaPDF_Core_Writer_HttpStream::$_inline = false

Flag saying that the file should be displayed inline or not

$_pos

protected int SetaPDF_Core_Writer_Echo::$_pos = 0

The current position

$_status

protected string SetaPDF_Core_Writer_AbstractWriter::$_status = 0

Status property

Methods

__construct()

public SetaPDF_Core_Writer_HttpStream::__construct (

string $filename = 'document.pdf',
bool $inline = false

)

The constructor.

Parameters

$filename : string: The document filename in UTF-8 encoding
$inline : bool: Defines if the document should be displayed inline or if a download should be forced

cleanUp()

public SetaPDF_Core_Writer_AbstractWriter::cleanUp (

void

): void

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

finish()

public SetaPDF_Core_Writer_AbstractWriter::finish (

void

): void

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

getPos()

public SetaPDF_Core_Writer_Echo::getPos (

void

): int

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_HttpStream::start (

void

): void

This method is called when the writing process is started.

It sends the HTTP headers.

write()

public SetaPDF_Core_Writer_Echo::write (

string $s

): void

Echo the string.

Parameters

$s : string