IMountPoint
A storage mounted to folder on the filesystem
Tags
Table of Contents
- 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
- getMountType() : string
- Get the type of mount point, used to distinguish things like shares and external storages in the web interface
- getNumericStorageId() : int
- Get the id of the storages
- getOption() : mixed
- Get a mount option
- getOptions() : array
- Get all options for the mount
- getStorage() : Storage
- Get the storage that is mounted
- getStorageId() : string
- 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
string —getMountId()
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
string —getMountType()
Get the type of mount point, used to distinguish things like shares and external storages in the web interface
public
getMountType() : string
Tags
Return values
string —getNumericStorageId()
Get the id of the storages
public
getNumericStorageId() : int
Tags
Return values
int —getOption()
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
Return values
mixed —getOptions()
Get all options for the mount
public
getOptions() : array
Tags
Return values
array —getStorage()
Get the storage that is mounted
public
getStorage() : Storage
Tags
Return values
Storage —getStorageId()
Get the id of the storages
public
getStorageId() : string
Tags
Return values
string —getStorageRootId()
Get the file id of the root of the storage
public
getStorageRootId() : int
Tags
Return values
int —setMountPoint()
Set the mountpoint
public
setMountPoint(string $mountPoint) : mixed
Parameters
- $mountPoint : string
-
new mount point
Tags
Return values
mixed —wrapStorage()
Apply a storage wrapper to the mounted storage
public
wrapStorage(callable $wrapper) : mixed
Parameters
- $wrapper : callable