IManager
in
This class provides access to files encryption apps.
Tags
Table of Contents
Methods
- getDefaultEncryptionModuleId() : string
- get default encryption module Id
- getEncryptionModule() : IEncryptionModule
- get a specific encryption module
- getEncryptionModules() : array<string|int, mixed>
- get a list of all encryption modules
- isEnabled() : bool
- Check if encryption is available (at least one encryption module needs to be enabled)
- registerEncryptionModule() : mixed
- Registers an callback function which must return an encryption module instance
- setDefaultEncryptionModule() : string
- set default encryption module Id
- unregisterEncryptionModule() : mixed
- Unregisters an encryption module
Methods
getDefaultEncryptionModuleId()
get default encryption module Id
public
getDefaultEncryptionModuleId() : string
Tags
Return values
stringgetEncryptionModule()
get a specific encryption module
public
getEncryptionModule([string $moduleId = '' ]) : IEncryptionModule
Parameters
- $moduleId : string = ''
-
Empty to get the default module
Tags
Return values
IEncryptionModulegetEncryptionModules()
get a list of all encryption modules
public
getEncryptionModules() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —[id => ['id' => $id, 'displayName' => $displayName, 'callback' => callback]]
isEnabled()
Check if encryption is available (at least one encryption module needs to be enabled)
public
isEnabled() : bool
Tags
Return values
bool —true if enabled, false if not
registerEncryptionModule()
Registers an callback function which must return an encryption module instance
public
registerEncryptionModule(string $id, string $displayName, callable $callback) : mixed
Parameters
- $id : string
- $displayName : string
- $callback : callable
Tags
setDefaultEncryptionModule()
set default encryption module Id
public
setDefaultEncryptionModule(string $moduleId) : string
Parameters
- $moduleId : string
Tags
Return values
stringunregisterEncryptionModule()
Unregisters an encryption module
public
unregisterEncryptionModule(string $moduleId) : mixed
Parameters
- $moduleId : string