\OCP\Files\External\BackendBackend

Storage backend

A backend can have services injected during construction, such as \OCP\IDB for database operations. This allows a backend to perform advanced operations based on provided information.

An authenication scheme defines the parameter interface, common to the storage implementation, the backend and the authentication mechanism. A storage implementation expects parameters according to the authentication scheme, which are provided from the authentication mechanism.

This class uses the following traits:

  • VisibilityTrait Restrict usage to admin-only/none
  • FrontendDefinitionTrait Specify configuration parameters and other definitions
  • PriorityTrait Allow objects to prioritize over others with the same mountpoint
  • DependencyTrait The object requires certain dependencies to be met
  • StorageModifierTrait Object can affect storage mounting

Summary

Methods
Properties
Constants
getStorageClass()
setStorageClass()
getAuthSchemes()
addAuthScheme()
jsonSerialize()
validateStorage()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$storageClass
$authSchemes
$legacyAuthMechanism
N/A

Properties

$storageClass

$storageClass : string

Type

string — storage class

$authSchemes

$authSchemes : array

Type

array — 'scheme' => true, supported authentication schemes

Methods

getStorageClass()

getStorageClass() : string

Returns

string

setStorageClass()

setStorageClass(string  $class) : self

Parameters

string $class

Returns

self

getAuthSchemes()

getAuthSchemes() : array

Returns

array

addAuthScheme()

addAuthScheme(string  $scheme) : self

Parameters

string $scheme

Returns

self

jsonSerialize()

jsonSerialize() : array

Serialize into JSON for client-side JS

Returns

array

validateStorage()

validateStorage(\OCP\Files\External\IStorageConfig  $storage) : boolean

Check if parameters are satisfied in a IStorageConfig

Parameters

\OCP\Files\External\IStorageConfig $storage

Returns

boolean