SetaPDF v2 API Reference

Index

\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

Outlines Class for collecting objects from the document outline

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

Class hierarchy

Outlines

Summary

Methods

__construct()
collect()

Properties

$_document

Properties

$_document

protected \SetaPDF_Core_Document Outlines::$_document

Methods

__construct()

public Outlines::__construct (

\SetaPDF_Core_Document $document

)

Parameters

$document : \SetaPDF_Core_Document

collect()

public Outlines::collect (

callable $addObjectCallback,
bool $withActionsOrDestinations = true

): void

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

Parameters

$addObjectCallback : callable
$withActionsOrDestinations : bool

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception