Class setasign\SetaPDF2\Core\Document\Catalog\Names in SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. Core
  1. Document
  2. Document
    1. Catalog
    2. Catalog
      1. Names
      2. Names
        
        EmbeddedFiles

setasign\SetaPDF2\Core\Document\Catalog

Names Class for handling Names in a PDF document

File: /SetaPDF v2/Core/Document/Catalog/Names.php
Old class name (alias): \SetaPDF_Core_Document_Catalog_Names

Class hierarchy

Names

Summary

Constants

ALTERNATE_PRESENTATIONS

public const string Names::ALTERNATE_PRESENTATIONS = 'AlternatePresentations'

Name/Category key

AP

public const string Names::AP = 'AP'

Name/Category key

DESTS

public const string Names::DESTS = 'Dests'

Name/Category key

EMBEDDED_FILES

public const string Names::EMBEDDED_FILES = 'EmbeddedFiles'

Name/Category key

IDS

public const string Names::IDS = 'IDS'

Name/Category key

JAVA_SCRIPT

public const string Names::JAVA_SCRIPT = 'JavaScript'

Name/Category key

PAGES

public const string Names::PAGES = 'Pages'

Name/Category key

RENDITIONS

public const string Names::RENDITIONS = 'Renditions'

Name/Category key

TEMPLATES

public const string Names::TEMPLATES = 'Templates'

Name/Category key

URLS

public const string Names::URLS = 'URLS'

Name/Category key

XFA_RESOURCES

public const string Names::XFA_RESOURCES = 'XFAResources'

Name/Category key

Properties

$_catalog

protected \SetaPDF_Core_Document_Catalog Names::$_catalog

The catalog instance

$_embeddedFiles

protected \SetaPDF_Core_Document_Catalog_Names_EmbeddedFiles Names::$_embeddedFiles

$_nameTrees

protected array Names::$_nameTrees = array()

$_namesDictionary

protected \SetaPDF_Core_Type_Dictionary Names::$_namesDictionary

The Names dictionary

Static Methods

getAvailableCategoryKeys()

public static Names::getAvailableCategoryKeys (

void

): array

Returns all available category keys of possible name trees.

Methods

__construct()

public Names::__construct (

\SetaPDF_Core_Document_Catalog $catalog

)

The constructor.

Parameters

$catalog : \SetaPDF_Core_Document_Catalog

cleanUp()

public 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 Names::getDocument (

void

): \SetaPDF_Core_Document

Get the document instance.

getEmbeddedFiles()

public Names::getEmbeddedFiles (

void

): \SetaPDF_Core_Document_Catalog_Names_EmbeddedFiles

Get the embedded files helper.

getNamesDictionary()

public Names::getNamesDictionary (

bool $create = false

): ?\SetaPDF_Core_Type_Dictionary

Returns the Names dictionary in the document's catalog.

Parameters

$create : bool

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception,\setasign\SetaPDF2\Core\Type\Exception

getTree()

public Names::getTree (

string $name,
bool $create = false

): ?\SetaPDF_Core_DataStructure_NameTree

Get a name tree by its name.

Parameters

$name : string
$create : bool

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

getTrees()

public Names::getTrees (

void

): \SetaPDF_Core_DataStructure_NameTree[]

Get all available name trees.

Return Values

Array of \setasign\SetaPDF2\Core\DataStructure\Tree\NameTree objects

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

See

Names::getAvailableCategoryKeys()