SetaPDF_Core_Document_Catalog_Outlines Class for handling a documents outline

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

Class hierarchy

Implements

Summary

Properties

$_catalog

$_outlinesDictionary


Methods

__construct()

appendChild()

appendChildCopy()

cleanUp()

Release memory / Cycled references.

getDocument()

Get the document instance.

getFirstItem()

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()

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()

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()

Get an item by a specific position.

Parameters
$offset : string|integer
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

See

offsetSet()

offsetUnset()

Removes an item at a specific position.

Parameters
$offset : string|integer
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

See