IMountProviderCollection
in
Manages the different mount providers
Tags
Table of Contents
Methods
- getHomeMountForUser() : IMountPoint
- Get the configured home mount for this user
- getMountCache() : IUserMountCache
- Get the mount cache which can be used to search for mounts without setting up the filesystem
- getMountsForUser() : array<string|int, IMountPoint>
- Get all configured mount points for the user
- getRootMounts() : array<string|int, IMountPoint>
- Get all root mountpoints
- getUserMountsForProviderClasses() : array<string|int, IMountPoint>
- Get the configured mount points for the user from a specific mount provider
- registerHomeProvider() : mixed
- Add a provider for home mount points
- registerMountFilter() : mixed
- Add a filter for mounts
- registerProvider() : mixed
- Add a provider for mount points
Methods
getHomeMountForUser()
Get the configured home mount for this user
public
getHomeMountForUser(IUser $user) : IMountPoint
Parameters
- $user : IUser
Tags
Return values
IMountPointgetMountCache()
Get the mount cache which can be used to search for mounts without setting up the filesystem
public
getMountCache() : IUserMountCache
Tags
Return values
IUserMountCachegetMountsForUser()
Get all configured mount points for the user
public
getMountsForUser(IUser $user) : array<string|int, IMountPoint>
Parameters
- $user : IUser
Tags
Return values
array<string|int, IMountPoint>getRootMounts()
Get all root mountpoints
public
getRootMounts() : array<string|int, IMountPoint>
Tags
Return values
array<string|int, IMountPoint>getUserMountsForProviderClasses()
Get the configured mount points for the user from a specific mount provider
public
getUserMountsForProviderClasses(IUser $user, array<string|int, IMountProvider>> $mountProviderClasses) : array<string|int, IMountPoint>
Parameters
- $user : IUser
- $mountProviderClasses : array<string|int, IMountProvider>>
Tags
Return values
array<string|int, IMountPoint>registerHomeProvider()
Add a provider for home mount points
public
registerHomeProvider(IHomeMountProvider $provider) : mixed
Parameters
- $provider : IHomeMountProvider
Tags
registerMountFilter()
Add a filter for mounts
public
registerMountFilter(callable $filter) : mixed
Parameters
- $filter : callable
-
(IMountPoint $mountPoint, IUser $user) => boolean
Tags
registerProvider()
Add a provider for mount points
public
registerProvider(IMountProvider $provider) : mixed
Parameters
- $provider : IMountProvider