Manuals

 

SetaPDF_Merger::merge()

Description

class SetaPDF_Merger extends SetaPDF {
mixed merge ( [string $fileName='doc.pdf'[, string $dest='F'[, boolean $stream=false[, boolean $keepParsers=false]]]] ) }

Defines the way the document is to be displayed by the viewer.

Parameters

$fileName

A valid path and filename for the new document if the dest-parameter is set to "F". Otherwise the name of the new PDF document.

$dest

Defines how the merged documents are handled:

  • "F" saves the file to the file system
  • "D" the file will be send to the client with a download dialogue
  • "I" the file will be displayed in the client's browser window.

$stream

This parameter is only used if dest is set to "D" or "I". If it is set to true, the document will be sent immediately as soon as the first content bytes are available. In this case the length-header will not be sent. If this parameter is set to false, the whole document is held in memory until it is completely assembled.

The streaming facility is very effective, because the client does not become aware of any script processing time.

$keepParsers

If set to true the PDF parser are keepd and are reusable for different merge()-calls.

Return Value

True - if everything works as expected - an SetaPDF_Error object if an error occurs.