Index

  1. \setasign\SetaPDF2
    1. Core
      1. Document
      2. Document
        1. Catalog
        2. Catalog
          1. AcroForm
          2. AdditionalActions
          3. Dests
          4. Extensions
          5. MarkInfo
          6. Names
          7. Names
          8. OptionalContent
          9. Outlines
          10. OutputIntents
          11. PageLabels
          12. Pages
          13. Permissions
          14. StructTreeRoot
          15. ViewerPreferences

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

Methods

Properties

Properties

$_catalog

protected \SetaPDF_Core_Document_Catalog Dests::$_catalog

The catalog instance


Methods

__construct()

public Dests::__construct ()

The constructor.

Parameters
$catalog : \SetaPDF_Core_Document_Catalog
 

add()

public Dests::add (): \SetaPDF_Core_Type_Name

Add or overwrite a named destination.

Parameters
$name : string|\SetaPDF_Core_Type_Name
 
$destination : \SetaPDF_Core_Document_Destination
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

cleanUp()

public Dests::cleanUp (
void
): void

Release memory and cycled references.

count()

public Dests::count (
void
): int

Count all available named destinations.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

get()

public Dests::get (
string $name
): false|\SetaPDF_Core_Document_Destination

Get a destination object by its name.

Parameters
$name : string
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

getAll()

public Dests::getAll (
void
): \SetaPDF_Core_Document_Destination[]

Get all destinations.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

getDictionary()

public Dests::getDictionary (
bool $create = false
): ?\SetaPDF_Core_Type_Dictionary

Get and creates the dictionary.

Parameters
$create : bool
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

getDocument()

public Dests::getDocument (
void
): \SetaPDF_Core_Document

Get the document instance.

getIterator()

public Dests::getIterator (
void
): \ArrayIterator

Implementation of the IteratorAggregate interface.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

offsetExists()

public Dests::offsetExists (
string $offset
): bool

Checks if a named destination exists

Parameters
$offset : string
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

offsetGet()

public Dests::offsetGet (
string $offset
): false|\SetaPDF_Core_Document_Destination

Get a destination by its name.

Parameters
$offset : string
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

offsetSet()

public Dests::offsetSet (): void
Parameters
$offset : string|\SetaPDF_Core_Type_Name
 
$value : \SetaPDF_Core_Document_Destination
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

offsetUnset()

public Dests::offsetUnset (
string $offset
): void

Removes a named destination.

Parameters
$offset : string
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

remove()

public Dests::remove (
string $name
): bool

Removes a named destination.

Parameters
$name : string
 
Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception


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