Index

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

SetaPDF_Core_Document_Catalog_Extensions Class for handling the catalogs extensions dictionary

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

Class hierarchy

Summary

Methods

Properties

Properties

$_catalog

protected SetaPDF_Core_Document_Catalog SetaPDF_Core_Document_Catalog_Extensions::$_catalog

The catalog instance


Methods

__construct()

public SetaPDF_Core_Document_Catalog_Extensions::__construct ()

The constructor.

Parameters
$catalog : SetaPDF_Core_Document_Catalog
 

cleanUp()

public SetaPDF_Core_Document_Catalog_Extensions::cleanUp (
void
): void

Release memory and cycled references.

getDictionary()

public SetaPDF_Core_Document_Catalog_Extensions::getDictionary (
[ bool $create = false ]
): null|SetaPDF_Core_Type_Dictionary

Get the extensions dictionary.

Parameters
$create : bool
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getExtension()

public SetaPDF_Core_Document_Catalog_Extensions::getExtension (
string $name
): array|bool

Get a developer extension by its name.

This method will return an array with the "baseVersion" and "extensionLevel" keys or false if no extension was found.

Parameters
$name : string
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getExtensions()

public SetaPDF_Core_Document_Catalog_Extensions::getExtensions (
void
): array

Get all defined developer extensions.

The method will return an array of the following structure: [$name => [baseVersion => "...", extensionLevel => "..."], ...]

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

removeExtension()

public SetaPDF_Core_Document_Catalog_Extensions::removeExtension (
string $name
): bool

Removes a developer extension from the dictionary.

Parameters
$name : string
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

setExtension()

public SetaPDF_Core_Document_Catalog_Extensions::setExtension (
string $name, string $baseVersion, integer $extensionLevel
): void

Set the data of a developer extension.

Parameters
$name : string
 
$baseVersion : string
 
$extensionLevel : integer
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception


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