phpdftk API Documentation

Catalog extends PdfObject
in package

PDF Document Catalog (/Type /Catalog).

This is the root object of every PDF document.

Table of Contents

Constants

PDF_TYPE  = 'Catalog'

Properties

$aa  : PdfReference|null
$acroForm  : PdfReference|null
$af  : PdfArray|null
$collection  : PdfReference|null
$dests  : PdfReference|null
$dPartRoot  : PdfReference|null
$dss  : DSS|PdfReference|null
$extensions  : PdfDictionary|null
$generationNumber  : int
$lang  : PdfString|null
$legal  : PdfDictionary|null
$markInfo  : MarkInfo|null
$metadata  : PdfReference|null
$names  : PdfReference|null
$needsRendering  : PdfBoolean|null
$objectNumber  : int
$ocProperties  : PdfReference|null
$openAction  : PdfReference|null
$outlines  : PdfReference|null
$outputIntents  : PdfArray|null
$pageLabels  : PdfReference|null
$pageLayout  : PdfName|null
$pageMode  : PdfName|null
$pages  : PdfReference|null
$perms  : PdfDictionary|null
$pieceInfo  : PdfDictionary|null
$requirements  : PdfArray|null
$spiderInfo  : PdfReference|null
$structTreeRoot  : PdfReference|null
$uri  : PdfDictionary|null
$version  : PdfName|null
$viewerPreferences  : Serializable|null
/ViewerPreferences — accepts an inline `PdfDictionary`, a `PdfReference` to a registered {@see ViewerPreferences} object, or the value itself when caller writes inline.

Methods

toIndirectObject()  : string
Wrap the object in an indirect object structure: X Y obj ... endobj
toPdf()  : string
Serialize the object's dictionary/value to PDF syntax.

Constants

PDF_TYPE

public mixed PDF_TYPE = 'Catalog'

Properties

$generationNumber

public int $generationNumber = 0

$viewerPreferences

/ViewerPreferences — accepts an inline `PdfDictionary`, a `PdfReference` to a registered {@see ViewerPreferences} object, or the value itself when caller writes inline.

public Serializable|null $viewerPreferences = null

Methods

toIndirectObject()

Wrap the object in an indirect object structure: X Y obj ... endobj

public toIndirectObject() : string
Return values
string

toPdf()

Serialize the object's dictionary/value to PDF syntax.

public toPdf() : string
Return values
string

        
On this page

Search results