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
Properties
$_catalog
The documents catalog instance.
Methods
__construct()
appendChild()
Append an item to the outline.
Parameters
- $item : \SetaPDF_Core_Document_OutlinesItem
The outline item that should be appended
Exceptions
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
Exceptions
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
getIterator()
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()
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
offsetExists()
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()
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()
Set an item at a specific position.
Parameters
- $offset : null|string|int
- $value : \SetaPDF_Core_Document_OutlinesItem
Exceptions
Throws \setasign\SetaPDF2\Core\SecHandler\Exception
Throws \setasign\SetaPDF2\Core\Type\Exception
See
- \setasign\SetaPDF2\Core\Document\Catalog\ArrayAccess::offsetSet()
- append()
- Outlines::appendChild()
- remove()
offsetUnset()
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()