SetaPDF_Core_Document_Catalog_Names Class for handling Names in a PDF document

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

Class hierarchy

Summary

Constants

ALTERNATE_PRESENTATIONS

public const string SetaPDF_Core_Document_Catalog_Names::ALTERNATE_PRESENTATIONS = 'AlternatePresentations'

Name/Category key

AP

public const string SetaPDF_Core_Document_Catalog_Names::AP = 'AP'

Name/Category key

DESTS

public const string SetaPDF_Core_Document_Catalog_Names::DESTS = 'Dests'

Name/Category key

EMBEDDED_FILES

public const string SetaPDF_Core_Document_Catalog_Names::EMBEDDED_FILES = 'EmbeddedFiles'

Name/Category key

IDS

public const string SetaPDF_Core_Document_Catalog_Names::IDS = 'IDS'

Name/Category key

JAVA_SCRIPT

public const string SetaPDF_Core_Document_Catalog_Names::JAVA_SCRIPT = 'JavaScript'

Name/Category key

PAGES

public const string SetaPDF_Core_Document_Catalog_Names::PAGES = 'Pages'

Name/Category key

RENDITIONS

public const string SetaPDF_Core_Document_Catalog_Names::RENDITIONS = 'Renditions'

Name/Category key

TEMPLATES

public const string SetaPDF_Core_Document_Catalog_Names::TEMPLATES = 'Templates'

Name/Category key

URLS

public const string SetaPDF_Core_Document_Catalog_Names::URLS = 'URLS'

Name/Category key

XFA_RESOURCES

public const string SetaPDF_Core_Document_Catalog_Names::XFA_RESOURCES = 'XFAResources'

Name/Category key


Properties

$_nameTrees

$_namesDictionary


Static Methods

getAvailableCategoryKeys()

Returns all available category keys of possible name trees.


Methods

__construct()

cleanUp()

Release objects to free memory and cycled references.

After calling this method the instance of this object is unusable!

getDocument()

Get the document instance.

getEmbeddedFiles()

getNamesDictionary()

Returns the Names dictionary in the document's catalog.

Parameters
$create : boolean
 

getTree()

public SetaPDF_Core_Document_Catalog_Names::getTree (
string $name [, boolean $create = false ]
): SetaPDF_Core_DataStructure_NameTree|null

Get a name tree by its name.

Parameters
$name : string
 
$create : boolean
 

getTrees()

Get all available name trees.

Return Values

Array of SetaPDF_Core_DataStructure_NameTree objects

See