SetaPDF v2 API Reference

SetaPDF_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

Class hierarchy

SetaPDF_Core_Document_Catalog_Permissions

Summary

Methods

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

Properties

$_catalog

Properties

$_catalog

protected SetaPDF_Core_Document SetaPDF_Core_Document_Catalog_Permissions::$_catalog

The documents catalog instance

Methods

__construct()

public SetaPDF_Core_Document_Catalog_Permissions::__construct (

SetaPDF_Core_Document_Catalog $catalog

)

The constructor.

Parameters

$catalog : SetaPDF_Core_Document_Catalog

cleanUp()

public SetaPDF_Core_Document_Catalog_Permissions::cleanUp (

void

): void

Release cycled references.

hasUsageRights()

public SetaPDF_Core_Document_Catalog_Permissions::hasUsageRights (

void

): bool

Checks if usage rights are defined for this document.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

removeUsageRights()

public SetaPDF_Core_Document_Catalog_Permissions::removeUsageRights (

void

): bool

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

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception