Interface SetaPDF_Core_SecHandler_SecHandlerInterface in SetaPDF v2 API Reference

Index

\SetaPDF
1. Core
2. Core
  1. SecHandler
  2. SecHandler

SetaPDF_Core_SecHandler_SecHandlerInterface Security handler interface

File: /SetaPDF v2/Core/SecHandler/SecHandlerInterface.php

Implemented in

Summary

Methods

auth()
decryptStream()
decryptString()
encryptStream()
encryptString()
getAuthMode()
getDocument()
getEncryptMetadata()
getEncryptionDictionary()
getEncryptionKey()
getPdfVersion()
getPermission()
getPermissions()
isAuth()

Methods

auth()

abstract public SetaPDF_Core_SecHandler_SecHandlerInterface::auth (

[ mixed $data = null ]

): boolean

Authenticate to the document with given credentials.

Parameters

$data : mixed: Credentials data

Return Values

Authentication was successful or not

decryptStream()

abstract public SetaPDF_Core_SecHandler_SecHandlerInterface::decryptStream (

string $data [, null|array|SetaPDF_Core_Type_IndirectObject $param = null ]

): void

Decrypts stream data through the desired security handler.

Parameters

$data : string
$param : null|array|SetaPDF_Core_Type_IndirectObject: An array of possible arguments

decryptString()

abstract public SetaPDF_Core_SecHandler_SecHandlerInterface::decryptString (

string $data [, null|array|SetaPDF_Core_Type_IndirectObject $param = null ]

): void

Decrypts string data through the desired security handler.

Parameters

$data : string
$param : null|array|SetaPDF_Core_Type_IndirectObject: An array of possible arguments

encryptStream()

abstract public SetaPDF_Core_SecHandler_SecHandlerInterface::encryptStream (

string $data [, mixed $param = null ]

): void

Encrypts stream data through the desired security handler.

Parameters

$data : string
$param : mixed

encryptString()

abstract public SetaPDF_Core_SecHandler_SecHandlerInterface::encryptString (

string $data [, mixed $param = null ]

): void

Encrypts string data through the desired security handler.

Parameters

$data : string
$param : mixed

getAuthMode()

abstract public SetaPDF_Core_SecHandler_SecHandlerInterface::getAuthMode (

void

): string

Get the auth mode.

getDocument()

abstract public SetaPDF_Core_SecHandler_SecHandlerInterface::getDocument (

void

): SetaPDF_Core_Document

Returns the document instance of this security handler.

getEncryptMetadata()

abstract public SetaPDF_Core_SecHandler_SecHandlerInterface::getEncryptMetadata (

void

): boolean

Returns true if the metadata are/will be encrypted.

getEncryptionDictionary()

abstract public SetaPDF_Core_SecHandler_SecHandlerInterface::getEncryptionDictionary (

void

): SetaPDF_Core_Type_Dictionary

Returns the encryption dictionary.

getEncryptionKey()

abstract public SetaPDF_Core_SecHandler_SecHandlerInterface::getEncryptionKey (

void

): string

Get the encryption key if known/authenticated.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

getPdfVersion()

abstract public SetaPDF_Core_SecHandler_SecHandlerInterface::getPdfVersion (

void

): string

Returns the needed PDF version for this security handler.

getPermission()

abstract public SetaPDF_Core_SecHandler_SecHandlerInterface::getPermission (

integer $permission

): void

Queries if a permission is granted.

Parameters

$permission : integer

getPermissions()

abstract public SetaPDF_Core_SecHandler_SecHandlerInterface::getPermissions (

void

): integer

Returns current permissions.

isAuth()

abstract public SetaPDF_Core_SecHandler_SecHandlerInterface::isAuth (

void

): boolean

Returns the status if the handler is authenticated and ready to encrypt and decrypt strings or streams.