SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. Core
  1. Writer

setasign\SetaPDF2\Core\Writer

HttpStreamWriter A writer class for immediately HTTP delivery without sending a Length header

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

Class hierarchy

AbstractWriter
- EchoWriter
  - HttpStreamWriter

Implements

Summary

Methods

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

Properties

$_filename
$_inline
$_pos
$_status

Properties

$_filename

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

The document filename

$_inline

protected bool HttpStreamWriter::$_inline = false

Flag saying that the file should be displayed inline or not

$_pos

protected int EchoWriter::$_pos = 0

The current position

$_status

protected string AbstractWriter::$_status = 0

Status property

Methods

__construct()

public HttpStreamWriter::__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 AbstractWriter::cleanUp (

void

): void

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

finish()

public AbstractWriter::finish (

void

): void

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

getPos()

public EchoWriter::getPos (

void

): int

Returns the current position.

getStatus()

public AbstractWriter::getStatus (

void

): string

Get the current status of the writer object.

start()

public HttpStreamWriter::start (

void

): void

This method is called when the writing process is started.

It sends the HTTP headers.

write()

public EchoWriter::write (

string $s

): void

Echo the string.

Parameters

$s : string