Index

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

setasign\SetaPDF2\Core\Document\Catalog

StructTreeRoot Class representing the access to the StructTreeRoot dictionary of a document

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

Class hierarchy

Summary

Methods

Properties

Properties

$_catalog

protected \setasign\SetaPDF2\Core\Document\Catalog StructTreeRoot::$_catalog

The catalog instance

$_idTree

protected \setasign\SetaPDF2\Core\DataStructure\Tree\NameTree StructTreeRoot::$_idTree

$_parentTree

protected \setasign\SetaPDF2\Core\DataStructure\Tree\NumberTree StructTreeRoot::$_parentTree

Methods

__construct()

public StructTreeRoot::__construct ()

The constructor.

Parameters
$catalog : \setasign\SetaPDF2\Core\Document\Catalog
 

addChild()

public StructTreeRoot::addChild (
\setasign\SetaPDF2\Core\Type\IndirectObjectInterface $object,
null $beforeIndex = null
): void

Add a child element.

Parameters
$object : \setasign\SetaPDF2\Core\Type\IndirectObjectInterface
 
$beforeIndex : null
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

cleanUp()

public StructTreeRoot::cleanUp (
void
): void

Release memory and cycled references.

exists()

public StructTreeRoot::exists (
void
): bool

Checks whether the StructTreeRoot dictionary exists or not.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

getAndIncrementParentTreeNextKey()

public StructTreeRoot::getAndIncrementParentTreeNextKey (
void
): int

Get the current next key for the parent tree and increase it.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

getChilds()

public StructTreeRoot::getChilds (
void
): array

Get the immediate children of the structure tree root.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

getClassMapDictionary()

public StructTreeRoot::getClassMapDictionary (
bool $create = false
): ?\setasign\SetaPDF2\Core\Type\PdfDictionary

Get the class-map dictionary.

Parameters
$create : bool

If set to true the dictionary will be created if it is not already available.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

getDictionary()

public StructTreeRoot::getDictionary (
bool $create = false
): ?\setasign\SetaPDF2\Core\Type\PdfDictionary

Get and creates the dictionary of the StructTreeRoot entry.

Parameters
$create : bool
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

getDocument()

public StructTreeRoot::getDocument (
void
): \setasign\SetaPDF2\Core\Document

Get the document instance.

getIdTree()

public StructTreeRoot::getIdTree (
bool $create = false
): ?\setasign\SetaPDF2\Core\DataStructure\Tree\NameTree

Get and create the id tree instance.

Parameters
$create : bool
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

getNamespacesArray()

public StructTreeRoot::getNamespacesArray (
bool $create = false
): ?\setasign\SetaPDF2\Core\Type\PdfArray

Get the namespaces array.

Parameters
$create : bool
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

getObject()

public StructTreeRoot::getObject (
bool $create = false
): ?\setasign\SetaPDF2\Core\Type\PdfIndirectObject

Gets and creates the indirect object of the StructTreeRoot entry.

Parameters
$create : bool
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

getParentTree()

public StructTreeRoot::getParentTree (
bool $create = false
): ?\setasign\SetaPDF2\Core\DataStructure\Tree\NumberTree

Gets and create the parent tree.

Parameters
$create : bool
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

getParentTreeNextKey()

public StructTreeRoot::getParentTreeNextKey (
void
): int

Get and sets the next key in the parent tree (if it not already exists).

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

getRoleMapDictionary()

public StructTreeRoot::getRoleMapDictionary (
bool $create = false
): ?\setasign\SetaPDF2\Core\Type\PdfDictionary

Get the role-map dictionary.

Parameters
$create : bool

If set to true the dictionary will be created if it is not already available.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception


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