SetaPDF_Core_Document_Catalog A class representing the document catalog

File: /SetaPDF v2/Core/Document/Catalog.php

Class hierarchy

Summary

Properties

$_acroForm

$_additionalActions

$_document

$_optionalContent

$_outlines

$_pageLabels

$_viewerPreferences


Static Methods

getDocumentMagicMethods()

Returns method names which should be available in a documents instance too.


Methods

__construct()

The constructor.

Parameters
$document : SetaPDF_Core_Document
 

cleanUp()

public SetaPDF_Core_Document_Catalog::cleanUp (
void
): void

Release cycled references / memory.

getAcroForm()

Get the documents AcroForm object.

This method resolves or creates the AcroForm dictionary and returns it.

getAdditionalActions()

getBaseUri()

public SetaPDF_Core_Document_Catalog::getBaseUri (
void
): null|string

Get the base URI that shall be used in resolving relative URI references.

URI actions within the document may specify URIs in partial form, to be interpreted relative to this base address. If no base URI is specified, such partial URIs shall be interpreted relative to the location of the document itself.

getDictionary()

public SetaPDF_Core_Document_Catalog::getDictionary (
[ boolean $create = false ]
): null|SetaPDF_Core_Type_Dictionary

Get the catalog dictionary.

Parameters
$create : boolean
 

getDocument()

Get the document instance.

getExtensions()

Get the extensions helper instance.

getMetadata()

public SetaPDF_Core_Document_Catalog::getMetadata (
void
): null|string

Get the metadata stream.

This is a method for low level access to the XMP stream data. The SetaPDF_Core_Document_Info class offers a same named method, that allows you to access the XMP package via a DOMDocument instance.

The class also allows you to automatically sync Info dictionary data with the XMP metadata.

Return Values

Null if no document metadata are available.
A string if the desired structure is available.

getNames()

Get a names object from the document.

getOpenAction()

Get the open action.

The open action entry specifies a destination that shall be displayed or an action that shall be executed when the document is opened.

Additional document related actions could be get or set in the SetaPDF_Core_Document_Catalog_AdditionalActions class that could be get with the getAdditionalActions() method.

Return Values

An action or destination instance or null if no open action is defined.

Exceptions

Throws SetaPDF_Core_Exception

getOptionalContent()

Get the documents optional content object.

getOutlines()

Get the documents outline object.

getOutputIntents()

getPageLabels()

Get the documents page labels object.

getPageLayout()

Get the page layout.

See
  • PDF 32000-1:2008 - 7.7.2 Document Catalog

getPageMode()

Get the page mode.

See
  • PDF 32000-1:2008 - 7.7.2 Document Catalog

getPages()

Get a pages object from the document.

getPermissions()

getVersion()

public SetaPDF_Core_Document_Catalog::getVersion (
void
): string|null

Get the value of the Version entry of the catalog dictionary.

This value defines the version of the PDF specification to which the document conforms if later than the version specified in the file's header.

getViewerPreferences()

setBaseUri()

public SetaPDF_Core_Document_Catalog::setBaseUri (
string $uri
): void

Set the base URI.

Parameters
$uri : string
 
See

setMetadata()

public SetaPDF_Core_Document_Catalog::setMetadata (
string $metadata
): void

Set the metadata stream.

To remove the metadata just pass null to this method.

Parameters
$metadata : string
 

setOpenAction()

Set the open action.

The open action entry specifies a destination that shall be displayed or an action that shall be executed when the document is opened.

Additional document related actions could be get or set in the SetaPDF_Core_Document_Catalog_AdditionalActions class that could be get with the getAdditionalActions() method.

Parameters
$openAction : SetaPDF_Core_Document_Destination|SetaPDF_Core_Document_Action

An SetaPDF_Core_Document_Action or SetaPDF_Core_Document_Destination object

Exceptions

Throws InvalidArgumentException

setPageLayout()

public SetaPDF_Core_Document_Catalog::setPageLayout (
string $pageLayout
): void

Set the page layout.

Possible values are declared as class constants in the SetaPDF_Core_Document_PageLayout class.

Parameters
$pageLayout : string

The name of the page layout

See

setPageMode()

public SetaPDF_Core_Document_Catalog::setPageMode (
string $pageMode
): void

Set the page mode.

Possible values are declared as class constants in the SetaPDF_Core_Document_PageMode class.

Parameters
$pageMode : string

The name of the page mode

See

setVersion()

public SetaPDF_Core_Document_Catalog::setVersion (
string $version
): void

Set the version of the PDF specification to which the document conforms.

Parameters
$version : string