SetaPDF_Core_SecHandler_SecHandlerInterface Security handler interface

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

Implemented in

Summary

Methods

auth()

abstract public boolean SetaPDF_Core_SecHandler_SecHandlerInterface::auth ( [ mixed $data = null ] )

Authenticate to the document with given credentials.

Parameters
$data : mixed

Credentials data

Return Values

Authentication was successful or not

decryptStream()

abstract public void SetaPDF_Core_SecHandler_SecHandlerInterface::decryptStream ( string $data [, null|array|SetaPDF_Core_Type_IndirectObject $param = null ] )

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 void SetaPDF_Core_SecHandler_SecHandlerInterface::decryptString ( string $data [, null|array|SetaPDF_Core_Type_IndirectObject $param = null ] )

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 void SetaPDF_Core_SecHandler_SecHandlerInterface::encryptStream ( string $data [, mixed $param = null ] )

Encrypts stream data through the desired security handler.

Parameters
$data : string
 
$param : mixed
 

encryptString()

abstract public void SetaPDF_Core_SecHandler_SecHandlerInterface::encryptString ( string $data [, mixed $param = null ] )

Encrypts string data through the desired security handler.

Parameters
$data : string
 
$param : mixed
 

getAuthMode()

abstract public string SetaPDF_Core_SecHandler_SecHandlerInterface::getAuthMode ( void )

Get the auth mode.

getDocument()

abstract public SetaPDF_Core_Document SetaPDF_Core_SecHandler_SecHandlerInterface::getDocument ( void )

Returns the document instance of this security handler.

getEncryptMetadata()

abstract public boolean SetaPDF_Core_SecHandler_SecHandlerInterface::getEncryptMetadata ( void )

Returns true if the metadata are/will be encrypted.

getEncryptionDictionary()

abstract public SetaPDF_Core_Type_Dictionary SetaPDF_Core_SecHandler_SecHandlerInterface::getEncryptionDictionary ( void )

Returns the encryption dictionary.

getEncryptionKey()

abstract public string SetaPDF_Core_SecHandler_SecHandlerInterface::getEncryptionKey ( void )

Get the encryption key if known/authenticated.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

getPdfVersion()

abstract public string SetaPDF_Core_SecHandler_SecHandlerInterface::getPdfVersion ( void )

Returns the needed PDF version for this security handler.

getPermission()

abstract public void SetaPDF_Core_SecHandler_SecHandlerInterface::getPermission ( integer $permission )

Queries if a permission is granted.

Parameters
$permission : integer
 

getPermissions()

abstract public integer SetaPDF_Core_SecHandler_SecHandlerInterface::getPermissions ( void )

Returns current permissions.

isAuth()

abstract public boolean SetaPDF_Core_SecHandler_SecHandlerInterface::isAuth ( void )

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