Index

  1. \SetaPDF
    1. Core
    2. Core
      1. Document
      2. Document
        1. ObjectCollector
        2. ObjectCollector
          1. AcroForm
          2. Annotations
          3. Dests
          4. Fonts
          5. Outlines
          6. Pages
          7. StructTree
          8. Tree

SetaPDF_Core_Document_ObjectCollector_StructTree Class for collecting objects from the StructTree structure

File: /SetaPDF v2/Core/Document/ObjectCollector/StructTree.php

Class hierarchy

Summary

Methods

Properties

Properties

$_document

protected SetaPDF_Core_Document SetaPDF_Core_Document_ObjectCollector_StructTree::$_document

Methods

__construct()

public SetaPDF_Core_Document_ObjectCollector_StructTree::__construct ()
Parameters
$document : SetaPDF_Core_Document
 

_collectClassMap()

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

Throws SetaPDF_Core_Document_ObjectNotFoundException

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_Parser_Pdf_InvalidTokenException

Throws SetaPDF_Core_Reader_Exception

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Type_IndirectReference_Exception

Throws SetaPDF_Exception

Throws SetaPDF_Exception_NotImplemented

_collectIdTree()

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

Throws SetaPDF_Core_Document_ObjectNotFoundException

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_Parser_Pdf_InvalidTokenException

Throws SetaPDF_Core_Reader_Exception

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Type_IndirectReference_Exception

Throws SetaPDF_Exception

Throws SetaPDF_Exception_NotImplemented

_collectKids()

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

Throws SetaPDF_Core_Document_ObjectNotFoundException

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_Parser_Pdf_InvalidTokenException

Throws SetaPDF_Core_Reader_Exception

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Type_IndirectReference_Exception

Throws SetaPDF_Exception

Throws SetaPDF_Exception_NotImplemented

_collectParentTree()

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

Throws SetaPDF_Core_Document_ObjectNotFoundException

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_Parser_Pdf_InvalidTokenException

Throws SetaPDF_Core_Reader_Exception

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Type_IndirectReference_Exception

Throws SetaPDF_Exception

Throws SetaPDF_Exception_NotImplemented

_collectRoleMap()

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

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

collect()

public SetaPDF_Core_Document_ObjectCollector_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 SetaPDF_Core_Document_ObjectNotFoundException

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_Parser_Pdf_InvalidTokenException

Throws SetaPDF_Core_Reader_Exception

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Type_IndirectReference_Exception

Throws SetaPDF_Exception

Throws SetaPDF_Exception_NotImplemented


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