Nextcloud PHP API (stable18)

IManager

This class provides access to files encryption apps.

Tags
since
8.1.0

Table of Contents

getDefaultEncryptionModuleId()  : string
get default encryption module Id
getEncryptionModule()  : IEncryptionModule
get a specific encryption module
getEncryptionModules()  : array
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
since
8.1.0
Return values
string

getEncryptionModule()

get a specific encryption module

public getEncryptionModule([string $moduleId = '' ]) : IEncryptionModule
Parameters
$moduleId : string = ''

Empty to get the default module

Tags
throws
ModuleDoesNotExistsException
since
8.1.0
Return values
IEncryptionModule

getEncryptionModules()

get a list of all encryption modules

public getEncryptionModules() : array
Tags
since
8.1.0
Return values
array

[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
since
8.1.0
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
throws
ModuleAlreadyExistsException
since
8.1.0
Return values
mixed

setDefaultEncryptionModule()

set default encryption module Id

public setDefaultEncryptionModule(string $moduleId) : string
Parameters
$moduleId : string
Tags
since
8.1.0
Return values
string

unregisterEncryptionModule()

Unregisters an encryption module

public unregisterEncryptionModule(string $moduleId) : mixed
Parameters
$moduleId : string
Tags
since
8.1.0
Return values
mixed

Search results