SetaPDF_Core_SecHandler_SecHandlerInterface Security handler interface
File: /SetaPDF v2/Core/SecHandler/SecHandlerInterface.php
Implemented in
Summary
Methods
auth()
abstract public SetaPDF_Core_SecHandler_SecHandlerInterface::auth (
[ mixed $data = null ]
): booleanAuthenticate 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 ]
): voidDecrypts 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 ]
): voidDecrypts 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 ]
): voidEncrypts 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 ]
): voidEncrypts string data through the desired security handler.
Parameters
- $data : string
- $param : mixed
getDocument()
abstract public SetaPDF_Core_SecHandler_SecHandlerInterface::getDocument (
void
): SetaPDF_Core_DocumentReturns the document instance of this security handler.
getEncryptionDictionary()
abstract public SetaPDF_Core_SecHandler_SecHandlerInterface::getEncryptionDictionary (
void
): SetaPDF_Core_Type_DictionaryReturns the encryption dictionary.
getPermission()
abstract public SetaPDF_Core_SecHandler_SecHandlerInterface::getPermission (
integer $permission
): voidQueries if a permission is granted.
Parameters
- $permission : integer
isAuth()
Returns the status if the handler is authenticated and ready to encrypt and decrypt strings or streams.