SetaPDF_Core_Document_Catalog_Outlines Class for handling a documents outline

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

Class hierarchy

Implements

Summary

Properties

$_catalog

$_iterator

$_outlinesDictionary


Methods

__construct()

appendChild()

Append an item to the outline.

Parameters
$item : SetaPDF_Core_Document_OutlinesItem

The outline item that should be append

appendChildCopy()

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

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.

getIterator()

Get the iterator reference for the outlines.

Parameters
$recreate : boolean

Specify to recreate the iterator instance

Return Values

A reference to the iterator

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.

offsetExists()

public boolean SetaPDF_Core_Document_Catalog_Outlines::offsetExists ( string $offset )

Checks if an item exists at a specific position.

Parameters
$offset : string
 
See

offsetGet()

Get an item by a specific position.

Parameters
$offset : string
 
Exceptions

Throws InvalidArgumentException

See

offsetSet()

Set an item at a specific position.

Parameters
$offset : null|string
 
$value : SetaPDF_Core_Document_OutlinesItem
 
See

offsetUnset()

Removes an item at a specific position.

Parameters
$offset : string
 
See