setasign\SetaPDF2\Core\Document\Catalog
Dests Class for handling the Dests dictionary in the Catalog
File: /SetaPDF v2/Core/Document/Catalog/Dests.php
Old class name (alias):
\SetaPDF_Core_Document_Catalog_Dests
Class hierarchy
Implements
Summary
Properties
Methods
__construct()
add()
public Dests::add (
string|\setasign\SetaPDF2\Core\Type\PdfName $name,
\setasign\SetaPDF2\Core\Document\Destination $destination
): \setasign\SetaPDF2\Core\Type\PdfName\setasign\SetaPDF2\Core\Document\Destination $destination
Add or overwrite a named destination.
Parameters
- $name : string|\setasign\SetaPDF2\Core\Type\PdfName
- $destination : \setasign\SetaPDF2\Core\Document\Destination
Exceptions
count()
Count all available named destinations.
Exceptions
get()
Get a destination object by its name.
Parameters
- $name : string
Exceptions
getAll()
getDictionary()
Get and creates the dictionary.
Parameters
- $create : bool
Exceptions
getIterator()
Implementation of the IteratorAggregate interface.
Exceptions
offsetExists()
Checks if a named destination exists
Parameters
- $offset : string
Exceptions
offsetGet()
Get a destination by its name.
Parameters
- $offset : string
Exceptions
offsetSet()
public Dests::offsetSet (
string|\setasign\SetaPDF2\Core\Type\PdfName $offset,
\setasign\SetaPDF2\Core\Document\Destination $value
): void\setasign\SetaPDF2\Core\Document\Destination $value
Parameters
- $offset : string|\setasign\SetaPDF2\Core\Type\PdfName
- $value : \setasign\SetaPDF2\Core\Document\Destination
Exceptions
offsetUnset()
Removes a named destination.
Parameters
- $offset : string
Exceptions
remove()
Removes a named destination.
Parameters
- $name : string