Index

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

SetaPDF_Core_Document_Catalog_Dests Class for handling the Dests dictionary in the Catalog

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

Class hierarchy

Implements

Summary

Methods

Properties

Properties

$_catalog

protected SetaPDF_Core_Document_Catalog SetaPDF_Core_Document_Catalog_Dests::$_catalog

The catalog instance


Methods

__construct()

public SetaPDF_Core_Document_Catalog_Dests::__construct ()

The constructor.

Parameters
$catalog : SetaPDF_Core_Document_Catalog
 

add()

public SetaPDF_Core_Document_Catalog_Dests::add (): void

Add or overwrite a named destination.

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

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

cleanUp()

public SetaPDF_Core_Document_Catalog_Dests::cleanUp (
void
): void

Release memory and cycled references.

count()

public SetaPDF_Core_Document_Catalog_Dests::count (
void
): int

Count all available named destinations.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

get()

public SetaPDF_Core_Document_Catalog_Dests::get (
string $name
): false|SetaPDF_Core_Document_Destination

Get a destination object by its name.

Parameters
$name : string
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getAll()

public SetaPDF_Core_Document_Catalog_Dests::getAll (
void
): SetaPDF_Core_Document_Destination[]

Get all destinations.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getDictionary()

public SetaPDF_Core_Document_Catalog_Dests::getDictionary (
[ boolean $create = false ]
): SetaPDF_Core_Type_Dictionary|null

Get and creates the dictionary.

Parameters
$create : boolean
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getDocument()

public SetaPDF_Core_Document_Catalog_Dests::getDocument (
void
): SetaPDF_Core_Document

Get the document instance.

getIterator()

public SetaPDF_Core_Document_Catalog_Dests::getIterator (
void
): ArrayIterator

Implementation of the IteratorAggregate interface.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

offsetExists()

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

Checks if a named destination exists

Parameters
$offset : string
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

offsetGet()

public SetaPDF_Core_Document_Catalog_Dests::offsetGet (
string $offset
): false|SetaPDF_Core_Document_Destination

Get a destination by its name.

Parameters
$offset : string
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

offsetSet()

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

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

offsetUnset()

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

Removes a named destination.

Parameters
$offset : string
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

remove()

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

Removes a named destination.

Parameters
$name : string
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception


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