Index

  1. \SetaPDF
    1. Core
    2. Core
      1. Document
      2. Document
        1. Catalog
        2. Catalog
          1. Names
          2. Names
          3. AcroForm
          4. AdditionalActions
          5. Dests
          6. Extensions
          7. MarkInfo
          8. OptionalContent
          9. Outlines
          10. OutputIntents
          11. PageLabels
          12. Pages
          13. Permissions
          14. StructTreeRoot
          15. ViewerPreferences

SetaPDF_Core_Document_Catalog A class representing the document catalog

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

Class hierarchy

Summary

Static Methods

Methods

Properties

Properties

$_acroForm

protected SetaPDF_Core_Document_Catalog_AcroForm SetaPDF_Core_Document_Catalog::$_acroForm

The documents AcroForm object

$_additionalActions

protected SetaPDF_Core_Document_Catalog_AdditionalActions SetaPDF_Core_Document_Catalog::$_additionalActions

The additional actions object

$_dests

protected SetaPDF_Core_Document_Catalog_Dests SetaPDF_Core_Document_Catalog::$_dests

The destinations object of the catalog

$_document

protected SetaPDF_Core_Document SetaPDF_Core_Document_Catalog::$_document

The document instance

$_extensions

protected SetaPDF_Core_Document_Catalog_Extensions SetaPDF_Core_Document_Catalog::$_extensions

The extensions object

$_markInfo

protected SetaPDF_Core_Document_Catalog_MarkInfo SetaPDF_Core_Document_Catalog::$_markInfo

The mark information object

$_names

protected SetaPDF_Core_Document_Catalog_Names SetaPDF_Core_Document_Catalog::$_names

Names instance

$_optionalContent

protected SetaPDF_Core_Document_Catalog_OptionalContent SetaPDF_Core_Document_Catalog::$_optionalContent

The optional content object

$_outlines

protected SetaPDF_Core_Document_Catalog_Outlines SetaPDF_Core_Document_Catalog::$_outlines

The documents outlines object

$_outputIntents

protected SetaPDF_Core_Document_Catalog_OutputIntents SetaPDF_Core_Document_Catalog::$_outputIntents

The output intent object

$_pageLabels

protected SetaPDF_Core_Document_Catalog_PageLabels SetaPDF_Core_Document_Catalog::$_pageLabels

The documents page labels object

$_pages

protected SetaPDF_Core_Document_Catalog_Pages SetaPDF_Core_Document_Catalog::$_pages

Pages instance

$_permissions

protected SetaPDF_Core_Document_Catalog_Permissions SetaPDF_Core_Document_Catalog::$_permissions

The permissions object

$_structTreeRoot

protected SetaPDF_Core_Document_Catalog_StructTreeRoot SetaPDF_Core_Document_Catalog::$_structTreeRoot

The root structure tree object

$_viewerPreferences

protected SetaPDF_Core_Document_Catalog_ViewerPreferences SetaPDF_Core_Document_Catalog::$_viewerPreferences

The viewer preferences object


Static Methods

getDocumentMagicMethods()

public static SetaPDF_Core_Document_Catalog::getDocumentMagicMethods (
void
): array

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


Methods

__construct()

public SetaPDF_Core_Document_Catalog::__construct ()

The constructor.

Parameters
$document : SetaPDF_Core_Document
 

cleanUp()

public SetaPDF_Core_Document_Catalog::cleanUp (
void
): void

Release cycled references / memory.

getAcroForm()

public SetaPDF_Core_Document_Catalog::getAcroForm (
void
): SetaPDF_Core_Document_Catalog_AcroForm

Get the documents AcroForm object.

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

getAdditionalActions()

public SetaPDF_Core_Document_Catalog::getAdditionalActions (
void
): SetaPDF_Core_Document_Catalog_AdditionalActions

Get the additional actions object.

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.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getDests()

public SetaPDF_Core_Document_Catalog::getDests (
void
): SetaPDF_Core_Document_Catalog_Dests

Get the documents destination dictionary helper object.

getDictionary()

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

Get the catalog dictionary.

Parameters
$create : boolean
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getDocument()

public SetaPDF_Core_Document_Catalog::getDocument (
void
): SetaPDF_Core_Document

Get the document instance.

getExtensions()

public SetaPDF_Core_Document_Catalog::getExtensions (
void
): SetaPDF_Core_Document_Catalog_Extensions

Get the extensions helper instance.

getLang()

public SetaPDF_Core_Document_Catalog::getLang (
[ string $encoding = 'UTF-8' ]
): string|null

Get the language identifier.

Parameters
$encoding : string
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getMarkInfo()

public SetaPDF_Core_Document_Catalog::getMarkInfo (
void
): SetaPDF_Core_Document_Catalog_MarkInfo

Get the mark information object.

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.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getNames()

public SetaPDF_Core_Document_Catalog::getNames (
void
): SetaPDF_Core_Document_Catalog_Names

Get a names object from the document.

getOpenAction()

public SetaPDF_Core_Document_Catalog::getOpenAction (
void
): null|SetaPDF_Core_Document_Action|SetaPDF_Core_Document_Destination

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()

public SetaPDF_Core_Document_Catalog::getOptionalContent (
void
): SetaPDF_Core_Document_Catalog_OptionalContent

Get the documents optional content object.

getOutlines()

public SetaPDF_Core_Document_Catalog::getOutlines (
void
): SetaPDF_Core_Document_Catalog_Outlines

Get the documents outline object.

getOutputIntents()

public SetaPDF_Core_Document_Catalog::getOutputIntents (
void
): SetaPDF_Core_Document_Catalog_OutputIntents

Get the output intents object.

getPageLabels()

public SetaPDF_Core_Document_Catalog::getPageLabels (
void
): SetaPDF_Core_Document_Catalog_PageLabels

Get the documents page labels object.

getPageLayout()

public SetaPDF_Core_Document_Catalog::getPageLayout (
void
): string

Get the page layout.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

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

getPageMode()

public SetaPDF_Core_Document_Catalog::getPageMode (
void
): string

Get the page mode.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

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

getPages()

public SetaPDF_Core_Document_Catalog::getPages (
void
): SetaPDF_Core_Document_Catalog_Pages

Get a pages object from the document.

getPermissions()

public SetaPDF_Core_Document_Catalog::getPermissions (
void
): SetaPDF_Core_Document_Catalog_Permissions

Get the permission object.

getStructTreeRoot()

public SetaPDF_Core_Document_Catalog::getStructTreeRoot (
void
): SetaPDF_Core_Document_Catalog_StructTreeRoot

Get the documents structure tree root object.

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.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getViewerPreferences()

public SetaPDF_Core_Document_Catalog::getViewerPreferences (
void
): SetaPDF_Core_Document_Catalog_ViewerPreferences

Get a viewer preferences object.

setBaseUri()

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

Set the base URI.

Parameters
$uri : string|null
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

See
  • self::getBaseUri()

setLang()

public SetaPDF_Core_Document_Catalog::setLang (
string $lang [, string $encoding = 'UTF-8' ]
): void

Set the language identifier.

Parameters
$lang : string
 
$encoding : string
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

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
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

setOpenAction()

public SetaPDF_Core_Document_Catalog::setOpenAction (): void

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|null
 
Exceptions

Throws InvalidArgumentException

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

setPageLayout()

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

Set the page layout.

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

Parameters
$pageLayout : string|null

The name of the page layout

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

See

setPageMode()

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

Set the page mode.

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

Parameters
$pageMode : string|null

The name of the page mode

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

See

setVersion()

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

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

Parameters
$version : string|null
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception


© 2024 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)