SetaPDF_Core_Document_Catalog_Names Class for handling Names in a PDF document

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

Class hierarchy

Summary

Constants

ALTERNATE_PRESENTATIONS

const string SetaPDF_Core_Document_Catalog_Names::ALTERNATE_PRESENTATIONS = 'AlternatePresentations'

Name/Category key

AP

Name/Category key

DESTS

Name/Category key

EMBEDDED_FILES

const string SetaPDF_Core_Document_Catalog_Names::EMBEDDED_FILES = 'EmbeddedFiles'

Name/Category key

IDS

Name/Category key

JAVA_SCRIPT

Name/Category key

PAGES

Name/Category key

RENDITIONS

const string SetaPDF_Core_Document_Catalog_Names::RENDITIONS = 'Renditions'

Name/Category key

TEMPLATES

Name/Category key

URLS

Name/Category key


Properties

$_nameTrees

$_namesDictionary


Static Methods

getAvailableCategoryKeys()

static public array SetaPDF_Core_Document_Catalog_Names::getAvailableCategoryKeys ( void )

Returns all available category keys of possible name trees.


Methods

__construct()

public SetaPDF_Core_Document_Catalog_Names::__construct ( SetaPDF_Core_Document_Catalog $catalog )

The constructor.

Parameters
$catalog : SetaPDF_Core_Document_Catalog
 

cleanUp()

public void SetaPDF_Core_Document_Catalog_Names::cleanUp ( void )

Release objects to free memory and cycled references.

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

getDocument()

public SetaPDF_Core_Document SetaPDF_Core_Document_Catalog_Names::getDocument ( void )

Get the document instance.

getNamesDictionary()

public null|SetaPDF_Core_Type_Dictionary SetaPDF_Core_Document_Catalog_Names::getNamesDictionary ( [ boolean $create = false ] )

Returns the Names dictionary in the document's catalog.

Parameters
$create : boolean
 

getTree()

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

Get a name tree by its name.

Parameters
$name : string
 
$create : boolean
 

getTrees()

public array SetaPDF_Core_Document_Catalog_Names::getTrees ( void )

Get all available name trees.

Return Values

Array of SetaPDF_Core_DataStructure_NameTree objects

See