Index

  1. \setasign\SetaPDF2
    1. Core
      1. Document
      2. Document
        1. ObjectCollector
          1. AcroForm
          2. Annotations
          3. Dests
          4. Fonts
          5. ObjectCollector
          6. ObjectCollectorInterface
          7. Outlines
          8. Pages
          9. StructTree
          10. Tree

setasign\SetaPDF2\Core\Document\ObjectCollector

StructTree Class for collecting objects from the StructTree structure

File: /SetaPDF v2/Core/Document/ObjectCollector/StructTree.php
Old class name (alias): \SetaPDF_Core_Document_ObjectCollector_StructTree

Class hierarchy

Summary

Methods

Properties

Properties

$_document

protected \SetaPDF_Core_Document StructTree::$_document

Methods

__construct()

public StructTree::__construct ()
Parameters
$document : \SetaPDF_Core_Document
 

_collectClassMap()

protected StructTree::_collectClassMap (
\SetaPDF_Core_Document_Catalog_StructTreeRoot $structTreeRoot,
callable $addObjectCallback
): void
Parameters
$structTreeRoot : \SetaPDF_Core_Document_Catalog_StructTreeRoot
 
$addObjectCallback : callable
 
Exceptions

Throws \setasign\SetaPDF2\Core\Document\ObjectNotFoundException

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\Parser\Pdf\InvalidTokenException

Throws \setasign\SetaPDF2\Core\Reader\Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Core\Type\IndirectReference\Exception

Throws \setasign\SetaPDF2\Exception

Throws \setasign\SetaPDF2\NotImplementedException

_collectIdTree()

protected StructTree::_collectIdTree (
\SetaPDF_Core_Document_Catalog_StructTreeRoot $structTreeRoot,
callable $addObjectCallback
): void
Parameters
$structTreeRoot : \SetaPDF_Core_Document_Catalog_StructTreeRoot
 
$addObjectCallback : callable
 
Exceptions

Throws \setasign\SetaPDF2\Core\Document\ObjectNotFoundException

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\Parser\Pdf\InvalidTokenException

Throws \setasign\SetaPDF2\Core\Reader\Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Core\Type\IndirectReference\Exception

Throws \setasign\SetaPDF2\Exception

Throws \setasign\SetaPDF2\NotImplementedException

_collectKids()

protected StructTree::_collectKids (
\SetaPDF_Core_Document_Catalog_StructTreeRoot $structTreeRoot,
callable $addObjectCallback
): void
Parameters
$structTreeRoot : \SetaPDF_Core_Document_Catalog_StructTreeRoot
 
$addObjectCallback : callable
 
Exceptions

Throws \setasign\SetaPDF2\Core\Document\ObjectNotFoundException

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\Parser\Pdf\InvalidTokenException

Throws \setasign\SetaPDF2\Core\Reader\Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Core\Type\IndirectReference\Exception

Throws \setasign\SetaPDF2\Exception

Throws \setasign\SetaPDF2\NotImplementedException

_collectParentTree()

protected StructTree::_collectParentTree (
\SetaPDF_Core_Document_Catalog_StructTreeRoot $structTreeRoot,
callable $addObjectCallback
): void
Parameters
$structTreeRoot : \SetaPDF_Core_Document_Catalog_StructTreeRoot
 
$addObjectCallback : callable
 
Exceptions

Throws \setasign\SetaPDF2\Core\Document\ObjectNotFoundException

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\Parser\Pdf\InvalidTokenException

Throws \setasign\SetaPDF2\Core\Reader\Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Core\Type\IndirectReference\Exception

Throws \setasign\SetaPDF2\Exception

Throws \setasign\SetaPDF2\NotImplementedException

_collectRoleMap()

public StructTree::_collectRoleMap (
\SetaPDF_Core_Document_Catalog_StructTreeRoot $structTreeRoot,
callable $addObjectCallback
): void
Parameters
$structTreeRoot : \SetaPDF_Core_Document_Catalog_StructTreeRoot
 
$addObjectCallback : callable
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

collect()

public StructTree::collect (
callable $addObjectCallback
): void

Collect all indirect objects/references for non-stream objects related to the StructTree structure of the document.

Parameters
$addObjectCallback : callable
 
Exceptions

Throws \setasign\SetaPDF2\Core\Document\ObjectNotFoundException

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\Parser\Pdf\InvalidTokenException

Throws \setasign\SetaPDF2\Core\Reader\Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Core\Type\IndirectReference\Exception

Throws \setasign\SetaPDF2\Exception

Throws \setasign\SetaPDF2\NotImplementedException


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