Constants

MOUNT_TYPE_ADMIN

MOUNT_TYPE_ADMIN

MOUNT_TYPE_PERSONAl

MOUNT_TYPE_PERSONAl

MOUNT_TYPE_GLOBAL

MOUNT_TYPE_GLOBAL

MOUNT_TYPE_GROUP

MOUNT_TYPE_GROUP

MOUNT_TYPE_USER

MOUNT_TYPE_USER

MOUNT_TYPE_PERSONAL

MOUNT_TYPE_PERSONAL

Methods

getId()

getId() : integer

Returns the configuration id

Returns

integer

setId()

setId(integer  $id) 

Sets the configuration id

Parameters

integer $id

configuration id

getMountPoint()

getMountPoint() : string

Returns mount point path relative to the user's "files" folder.

Returns

string —

path

setMountPoint()

setMountPoint(string  $mountPoint) 

Sets mount point path relative to the user's "files" folder.

The path will be normalized.

Parameters

string $mountPoint

path

getBackendOptions()

getBackendOptions() : array

Returns the external storage backend-specific options

Returns

array —

backend options

setBackendOptions()

setBackendOptions(array  $backendOptions) 

Sets the external storage backend-specific options

Parameters

array $backendOptions

backend options

getBackendOption()

getBackendOption(string  $key) : mixed

Parameters

string $key

Returns

mixed

setBackendOption()

setBackendOption(string  $key, mixed  $value) 

Parameters

string $key
mixed $value

getPriority()

getPriority() : integer

Returns the mount priority

Returns

integer —

priority

setPriority()

setPriority(integer  $priority) 

Sets the mount priotity

Parameters

integer $priority

priority

getApplicableUsers()

getApplicableUsers() : array

Returns the users for which to mount this storage

Returns

array —

applicable users

setApplicableUsers()

setApplicableUsers(array|null  $applicableUsers) 

Sets the users for which to mount this storage

Parameters

array|null $applicableUsers

applicable users

getApplicableGroups()

getApplicableGroups() : array

Returns the groups for which to mount this storage

Returns

array —

applicable groups

setApplicableGroups()

setApplicableGroups(array|null  $applicableGroups) 

Sets the groups for which to mount this storage

Parameters

array|null $applicableGroups

applicable groups

getMountOptions()

getMountOptions() : array

Returns the mount-specific options

Returns

array —

mount specific options

setMountOptions()

setMountOptions(array  $mountOptions) 

Sets the mount-specific options

Parameters

array $mountOptions

applicable groups

getMountOption()

getMountOption(string  $key) : mixed

Parameters

string $key

Returns

mixed

setMountOption()

setMountOption(string  $key, mixed  $value) 

Parameters

string $key
mixed $value

getStatus()

getStatus() : integer

Gets the storage status, whether the config worked last time

Returns

integer —

$status status

getStatusMessage()

getStatusMessage() : string|null

Gets the message describing the storage status

Returns

string|null

setStatus()

setStatus(integer  $status, string|null  $message = null) 

Sets the storage status, whether the config worked last time

Parameters

integer $status

status

string|null $message

optional message

getType()

getType() : integer

Returns

integer —

self::MOUNT_TYPE_ADMIN or self::MOUNT_TYPE_PERSONAl

setType()

setType(integer  $type) 

Parameters

integer $type

self::MOUNT_TYPE_ADMIN or self::MOUNT_TYPE_PERSONAl

jsonSerialize()

jsonSerialize() : array

Serialize config to JSON

Returns

array