SetaPDF v2 API Reference

Index

\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

Permissions Class representing a helper object for the Perms entry in the document catalog.

File: /SetaPDF v2/Core/Document/Catalog/Permissions.php
Old class name (alias): \SetaPDF_Core_Document_Catalog_Permissions

Class hierarchy

Permissions

Summary

Methods

__construct()
cleanUp()
hasUsageRights()
removeUsageRights()

Properties

$_catalog

Properties

$_catalog

protected \SetaPDF_Core_Document Permissions::$_catalog

The documents catalog instance

Methods

__construct()

public Permissions::__construct (

\SetaPDF_Core_Document_Catalog $catalog

)

The constructor.

Parameters

$catalog : \SetaPDF_Core_Document_Catalog

cleanUp()

public Permissions::cleanUp (

void

): void

Release cycled references.

hasUsageRights()

public Permissions::hasUsageRights (

void

): bool

Checks if usage rights are defined for this document.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

removeUsageRights()

public Permissions::removeUsageRights (

void

): bool

Removes the usage rights if they are defined for this document.

Exceptions

Throws \setasign\SetaPDF2\Core\SecHandler\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception