Index

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

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

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

Class hierarchy

Summary

Methods

Properties

Properties

$_catalog

protected SetaPDF_Core_Document_Catalog SetaPDF_Core_Document_Catalog_StructTreeRoot::$_catalog

The catalog instance

$_parentTree

protected SetaPDF_Core_DataStructure_NumberTree SetaPDF_Core_Document_Catalog_StructTreeRoot::$_parentTree

Methods

__construct()

public SetaPDF_Core_Document_Catalog_StructTreeRoot::__construct ()

The constructor.

Parameters
$catalog : SetaPDF_Core_Document_Catalog
 

addChild()

public SetaPDF_Core_Document_Catalog_StructTreeRoot::addChild (
SetaPDF_Core_Type_IndirectObjectInterface $object [, null $beforeIndex = null ]
): void

Add a child element.

Parameters
$object : SetaPDF_Core_Type_IndirectObjectInterface
 
$beforeIndex : null
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

cleanUp()

public SetaPDF_Core_Document_Catalog_StructTreeRoot::cleanUp (
void
): void

Release memory and cycled references.

exists()

public SetaPDF_Core_Document_Catalog_StructTreeRoot::exists (
void
): bool

Checks whether the StructTreeRoot dictionary exists or not.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getAndIncrementParentTreeNextKey()

public SetaPDF_Core_Document_Catalog_StructTreeRoot::getAndIncrementParentTreeNextKey (
void
): int

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

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getChilds()

public SetaPDF_Core_Document_Catalog_StructTreeRoot::getChilds (
void
): array

Get the immediate children of the structure tree root.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getDictionary()

public SetaPDF_Core_Document_Catalog_StructTreeRoot::getDictionary (
[ bool $create = false ]
): SetaPDF_Core_Type_Dictionary|null

Get and creates the dictionary of the StructTreeRoot entry.

Parameters
$create : bool
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getDocument()

public SetaPDF_Core_Document_Catalog_StructTreeRoot::getDocument (
void
): SetaPDF_Core_Document

Get the document instance.

getObject()

public SetaPDF_Core_Document_Catalog_StructTreeRoot::getObject (
[ bool $create = false ]
): SetaPDF_Core_Type_IndirectObject|null

Gets and creates the indirect object of the StructTreeRoot entry.

Parameters
$create : bool
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getParentTree()

public SetaPDF_Core_Document_Catalog_StructTreeRoot::getParentTree (
[ bool $create = false ]
): SetaPDF_Core_DataStructure_NumberTree|null

Gets and create the parent tree.

Parameters
$create : bool
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getParentTreeNextKey()

public SetaPDF_Core_Document_Catalog_StructTreeRoot::getParentTreeNextKey (
void
): int

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

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception


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