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_Outlines Class for handling a documents outline

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

Class hierarchy

Implements

Summary

Methods

Properties

Properties

$_catalog

protected SetaPDF_Core_Document_Catalog SetaPDF_Core_Document_Catalog_Outlines::$_catalog

The documents catalog instance.

$_outlinesDictionary

protected SetaPDF_Core_Type_Dictionary SetaPDF_Core_Document_Catalog_Outlines::$_outlinesDictionary

The root outlines' dictionary.


Methods

__construct()

public SetaPDF_Core_Document_Catalog_Outlines::__construct ()

The constructor.

Parameters
$catalog : SetaPDF_Core_Document_Catalog
 

appendChild()

public SetaPDF_Core_Document_Catalog_Outlines::appendChild (): SetaPDF_Core_Document_Catalog_Outlines

Append an item to the outline.

Parameters
$item : SetaPDF_Core_Document_OutlinesItem

The outline item that should be appended

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

appendChildCopy()

public SetaPDF_Core_Document_Catalog_Outlines::appendChildCopy (): void

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

Parameters
$item : SetaPDF_Core_Document_OutlinesItem|SetaPDF_Core_Document_Catalog_Outlines

The item or root outlines dictionary

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

cleanUp()

public SetaPDF_Core_Document_Catalog_Outlines::cleanUp (
void
): void

Release memory / Cycled references.

getDocument()

public SetaPDF_Core_Document_Catalog_Outlines::getDocument (
void
): SetaPDF_Core_Document

Get the document instance.

getFirstItem()

public SetaPDF_Core_Document_Catalog_Outlines::getFirstItem (
void
): bool|SetaPDF_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 SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getIterator()

public SetaPDF_Core_Document_Catalog_Outlines::getIterator (
void
): EmptyIterator|RecursiveIteratorIterator

Get the iterator reference for the outlines.

Return Values

A reference to the iterator

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

See

getLastItem()

public SetaPDF_Core_Document_Catalog_Outlines::getLastItem (
void
): bool|SetaPDF_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 SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_SecHandler_Exception

offsetExists()

public SetaPDF_Core_Document_Catalog_Outlines::offsetExists (
string|integer $offset
): bool

Checks if an item exists at a specific position.

Parameters
$offset : string|integer
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

See

offsetGet()

public SetaPDF_Core_Document_Catalog_Outlines::offsetGet (
string|integer $offset
): SetaPDF_Core_Document_OutlinesItem

Get an item by a specific position.

Parameters
$offset : string|integer
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

See

offsetSet()

public SetaPDF_Core_Document_Catalog_Outlines::offsetSet (
null|string|integer $offset, SetaPDF_Core_Document_OutlinesItem $value
): void

Set an item at a specific position.

Parameters
$offset : null|string|integer
 
$value : SetaPDF_Core_Document_OutlinesItem
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

See

offsetUnset()

public SetaPDF_Core_Document_Catalog_Outlines::offsetUnset (
string|integer $offset
): SetaPDF_Core_Document_OutlinesItem

Removes an item at a specific position.

Parameters
$offset : string|integer
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

See

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