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

Outlines Class for handling a documents outline

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

Class hierarchy

Implements

Summary

Methods

Properties

Properties

$_catalog

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

The documents catalog instance.

$_outlinesDictionary

protected \setasign\SetaPDF2\Core\Type\PdfDictionary Outlines::$_outlinesDictionary

The root outlines' dictionary.


Methods

__construct()

public Outlines::__construct ()

The constructor.

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

appendChild()

public Outlines::appendChild (): Outlines

Append an item to the outline.

Parameters
$item : \setasign\SetaPDF2\Core\Document\OutlinesItem

The outline item that should be appended

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

appendChildCopy()

public Outlines::appendChildCopy (): void

Append a copy of an item or outline to this outline.

Parameters
$item : \setasign\SetaPDF2\Core\Document\OutlinesItem|Outlines

The item or root outlines dictionary

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

cleanUp()

public Outlines::cleanUp (
void
): void

Release memory / Cycled references.

getDocument()

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

Get the document instance.

getFirstItem()

public Outlines::getFirstItem (
void
): bool|\setasign\SetaPDF2\Core\Document\OutlinesItem

Get an item instance of the item referenced in the 'First' key.

Return Values

The first item of the outlines root dictionary or false if no item is set.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

getIterator()

public Outlines::getIterator (
void
): \EmptyIterator|\RecursiveIteratorIterator

Get the iterator reference for the outlines.

Return Values

A reference to the iterator

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

See
  • \setasign\SetaPDF2\Core\Document\Catalog\IteratorAggregate::getIterator()

getLastItem()

public Outlines::getLastItem (
void
): bool|\setasign\SetaPDF2\Core\Document\OutlinesItem

Get an item instance of the item referenced in the 'Last' key.

Return Values

The last item of the outlines root dictionary or false if no item is set.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

offsetExists()

public Outlines::offsetExists (
string|int $offset
): bool

Checks if an item exists at a specific position.

Parameters
$offset : string|int
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

See
  • \setasign\SetaPDF2\Core\Document\Catalog\ArrayAccess::offsetExists()

offsetGet()

public Outlines::offsetGet (
string|int $offset
): \setasign\SetaPDF2\Core\Document\OutlinesItem

Get an item by a specific position.

Parameters
$offset : string|int
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

See
  • \setasign\SetaPDF2\Core\Document\Catalog\ArrayAccess::offsetGet()

offsetSet()

public Outlines::offsetSet (
null|string|int $offset,
\setasign\SetaPDF2\Core\Document\OutlinesItem $value
): void

Set an item at a specific position.

Parameters
$offset : null|string|int
 
$value : \setasign\SetaPDF2\Core\Document\OutlinesItem
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

See

offsetUnset()

public Outlines::offsetUnset (
string|int $offset
): \setasign\SetaPDF2\Core\Document\OutlinesItem

Removes an item at a specific position.

Parameters
$offset : string|int
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

See
  • \setasign\SetaPDF2\Core\Document\Catalog\ArrayAccess::offsetUnset()

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