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
$aa
public
PdfReference|null
$aa
= null
$acroForm
public
PdfReference|null
$acroForm
= null
$af
public
PdfArray|null
$af
= null
Attributes
- #[RequiresPdfVersion]
- \Phpdftk\Pdf\Core\PdfVersion::V2_0
$collection
public
PdfReference|null
$collection
= null
$dests
public
PdfReference|null
$dests
= null
$dPartRoot
public
PdfReference|null
$dPartRoot
= null
Attributes
- #[RequiresPdfVersion]
- \Phpdftk\Pdf\Core\PdfVersion::V2_0
$dss
public
DSS|PdfReference|null
$dss
= null
Attributes
- #[RequiresPdfVersion]
- \Phpdftk\Pdf\Core\PdfVersion::V2_0
$extensions
public
PdfDictionary|null
$extensions
= null
Attributes
- #[RequiresPdfVersion]
- \Phpdftk\Pdf\Core\PdfVersion::V1_7
$generationNumber
public
int
$generationNumber
= 0
$lang
public
PdfString|null
$lang
= null
$legal
public
PdfDictionary|null
$legal
= null
$markInfo
public
MarkInfo|null
$markInfo
= null
$metadata
public
PdfReference|null
$metadata
= null
$names
public
PdfReference|null
$names
= null
$needsRendering
public
PdfBoolean|null
$needsRendering
= null
$objectNumber
public
int
$objectNumber
= 0
$ocProperties
public
PdfReference|null
$ocProperties
= null
$openAction
public
PdfReference|null
$openAction
= null
$outlines
public
PdfReference|null
$outlines
= null
$outputIntents
public
PdfArray|null
$outputIntents
= null
$pageLabels
public
PdfReference|null
$pageLabels
= null
$pageLayout
public
PdfName|null
$pageLayout
= null
$pageMode
public
PdfName|null
$pageMode
= null
$pages
public
PdfReference|null
$pages
= null
$perms
public
PdfDictionary|null
$perms
= null
$pieceInfo
public
PdfDictionary|null
$pieceInfo
= null
$requirements
public
PdfArray|null
$requirements
= null
$spiderInfo
public
PdfReference|null
$spiderInfo
= null
$structTreeRoot
public
PdfReference|null
$structTreeRoot
= null
$uri
public
PdfDictionary|null
$uri
= null
$version
public
PdfName|null
$version
= null
$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
stringtoPdf()
Serialize the object's dictionary/value to PDF syntax.
public
toPdf() : string