Class SetaPDF_Core_Document_Catalog_Names in SetaPDF v2 API Reference

Index

\SetaPDF
1. Core
2. Core
  1. Document
  2. Document
    1. Catalog
    2. Catalog
      1. Names
      2. Names
        EmbeddedFiles

SetaPDF_Core_Document_Catalog_Names Class for handling Names in a PDF document

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

Class hierarchy

SetaPDF_Core_Document_Catalog_Names

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

$_catalog

protected SetaPDF_Core_Document_Catalog SetaPDF_Core_Document_Catalog_Names::$_catalog

The catalog instance

$_embeddedFiles

protected SetaPDF_Core_Document_Catalog_Names_EmbeddedFiles SetaPDF_Core_Document_Catalog_Names::$_embeddedFiles

$_nameTrees

protected array SetaPDF_Core_Document_Catalog_Names::$_nameTrees = array()

$_namesDictionary

protected SetaPDF_Core_Type_Dictionary SetaPDF_Core_Document_Catalog_Names::$_namesDictionary

The Names dictionary

Static Methods

getAvailableCategoryKeys()

public static SetaPDF_Core_Document_Catalog_Names::getAvailableCategoryKeys (

void

): array

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 SetaPDF_Core_Document_Catalog_Names::cleanUp (

void

): 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_Catalog_Names::getDocument (

void

): SetaPDF_Core_Document

Get the document instance.

getEmbeddedFiles()

public SetaPDF_Core_Document_Catalog_Names::getEmbeddedFiles (

void

): SetaPDF_Core_Document_Catalog_Names_EmbeddedFiles

Get the embedded files helper.

getNamesDictionary()

public SetaPDF_Core_Document_Catalog_Names::getNamesDictionary (

[ boolean $create = false ]

): null|SetaPDF_Core_Type_Dictionary

Returns the Names dictionary in the document's catalog.

Parameters

$create : boolean

Exceptions

Throws SetaPDF_Core_SecHandler_Exception,SetaPDF_Core_Type_Exception

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

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getTrees()

public SetaPDF_Core_Document_Catalog_Names::getTrees (

void

): SetaPDF_Core_DataStructure_NameTree[]

Get all available name trees.

Return Values

Array of SetaPDF_Core_DataStructure_NameTree objects

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

See

SetaPDF_Core_Document_Catalog_Names::getAvailableCategoryKeys()