IMountPoint
in
A storage mounted to folder on the filesystem
Tags
Table of Contents
Methods
- getInternalPath() : string
- Get the path relative to the mountpoint
- getMountId() : int|null
- Get the id of the configured mount
- getMountPoint() : string
- get complete path to the mount point
- getMountProvider() : string
- Get the class of the mount provider that this mount originates from
- getMountType() : string
- Get the type of mount point, used to distinguish things like shares and external storage in the web interface
- getNumericStorageId() : int|null
- Get the id of the storages
- getOption() : mixed
- Get a mount option
- getOptions() : array<string|int, mixed>
- Get all options for the mount
- getStorage() : IStorage|null
- Get the storage that is mounted
- getStorageId() : string|null
- Get the id of the storages
- getStorageRootId() : int
- Get the file id of the root of the storage
- setMountPoint() : mixed
- Set the mountpoint
- wrapStorage() : mixed
- Apply a storage wrapper to the mounted storage
Methods
getInternalPath()
Get the path relative to the mountpoint
public
getInternalPath(string $path) : string
Parameters
- $path : string
-
absolute path to a file or folder
Tags
Return values
stringgetMountId()
Get the id of the configured mount
public
getMountId() : int|null
Tags
Return values
int|null —mount id or null if not applicable
getMountPoint()
get complete path to the mount point
public
getMountPoint() : string
Tags
Return values
stringgetMountProvider()
Get the class of the mount provider that this mount originates from
public
getMountProvider() : string
Tags
Return values
stringgetMountType()
Get the type of mount point, used to distinguish things like shares and external storage in the web interface
public
getMountType() : string
Tags
Return values
stringgetNumericStorageId()
Get the id of the storages
public
getNumericStorageId() : int|null
Tags
Return values
int|nullgetOption()
Get a mount option
public
getOption(string $name, mixed $default) : mixed
Parameters
- $name : string
-
Name of the mount option to get
- $default : mixed
-
Default value for the mount option
Tags
getOptions()
Get all options for the mount
public
getOptions() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>getStorage()
Get the storage that is mounted
public
getStorage() : IStorage|null
Tags
Return values
IStorage|nullgetStorageId()
Get the id of the storages
public
getStorageId() : string|null
Tags
Return values
string|nullgetStorageRootId()
Get the file id of the root of the storage
public
getStorageRootId() : int
Tags
Return values
intsetMountPoint()
Set the mountpoint
public
setMountPoint(string $mountPoint) : mixed
Parameters
- $mountPoint : string
-
new mount point
Tags
wrapStorage()
Apply a storage wrapper to the mounted storage
public
wrapStorage(callable $wrapper) : mixed
Parameters
- $wrapper : callable