IMountPoint¶

interface OCP\Files\Mount\IMountPoint¶

A storage mounted to folder on the filesystem

Implemented by:	`OC\Files\Mount\MountPoint`
Source:	lib/public/Files/Mount/IMountPoint.php#30

Methods¶

public OCP\Files\Mount\IMountPoint::getMountPoint()¶

get complete path to the mount point

Source:	lib/public/Files/Mount/IMountPoint.php#38
Returns:	string
Since:	8.0.0

public OCP\Files\Mount\IMountPoint::setMountPoint($mountPoint)¶

Set the mountpoint

Source:	lib/public/Files/Mount/IMountPoint.php#46
Parameters:	$mountPoint (string) new mount point
Since:	8.0.0

public OCP\Files\Mount\IMountPoint::getStorage()¶

Get the storage that is mounted

Source:	lib/public/Files/Mount/IMountPoint.php#54
Returns:	`\OC\Files\Storage\Storage` \| null
Since:	8.0.0

public OCP\Files\Mount\IMountPoint::getStorageId()¶

Get the id of the storages

Source:	lib/public/Files/Mount/IMountPoint.php#62
Returns:	string
Since:	8.0.0

public OCP\Files\Mount\IMountPoint::getNumericStorageId()¶

Get the id of the storages

Source:	lib/public/Files/Mount/IMountPoint.php#70
Returns:	int
Since:	9.1.0

public OCP\Files\Mount\IMountPoint::getInternalPath($path)¶

Get the path relative to the mountpoint

Source:	lib/public/Files/Mount/IMountPoint.php#79
Parameters:	$path (string) absolute path to a file or folder
Returns:	string
Since:	8.0.0

public OCP\Files\Mount\IMountPoint::wrapStorage($wrapper)¶

Apply a storage wrapper to the mounted storage

Source:	lib/public/Files/Mount/IMountPoint.php#87
Parameters:	$wrapper (callable)
Since:	8.0.0

public OCP\Files\Mount\IMountPoint::getOption($name, $default)¶

Get a mount option

Source:	lib/public/Files/Mount/IMountPoint.php#97
Parameters:	$name (string) Name of the mount option to get $default (mixed) Default value for the mount option
Returns:	mixed
Since:	8.0.0

public OCP\Files\Mount\IMountPoint::getOptions()¶

Get all options for the mount

Source:	lib/public/Files/Mount/IMountPoint.php#105
Returns:	array
Since:	8.1.0

public OCP\Files\Mount\IMountPoint::getStorageRootId()¶

Get the file id of the root of the storage

Source:	lib/public/Files/Mount/IMountPoint.php#113
Returns:	int
Since:	9.1.0

public OCP\Files\Mount\IMountPoint::getMountId()¶

Get the id of the configured mount

Source:	lib/public/Files/Mount/IMountPoint.php#121
Returns:	int \| null mount id or null if not applicable
Since:	9.1.0

public OCP\Files\Mount\IMountPoint::getMountType()¶

Get the type of mount point, used to distinguish things like shares and external storages

in the web interface

Source:	lib/public/Files/Mount/IMountPoint.php#130
Returns:	string
Since:	12.0.0