ISetupManager
in
The files setup manager allow to set up the file system for specific users and also to tear it down when no longer needed.
This is mostly useful in backgroun jobs, where an operation need to be done for multiple users and their file system need to be setup and teared down between each user.
Tags
Attributes
- #[Consumable]
- $since: '34.0.0'
Table of Contents
Methods
- isSetupComplete() : bool
- Get whether the file system is already setup for a specific user.
- setupForPath() : void
- Set up the filesystem for the specified path, optionally including all children mounts.
- setupForUser() : void
- Set up the full filesystem for a specified user.
- tearDown() : void
- Tear down all file systems to free some memory.
Methods
isSetupComplete()
Get whether the file system is already setup for a specific user.
public
isSetupComplete(IUser $user) : bool
Parameters
- $user : IUser
Return values
boolsetupForPath()
Set up the filesystem for the specified path, optionally including all children mounts.
public
setupForPath(string $path[, bool $includeChildren = false ]) : void
Parameters
- $path : string
- $includeChildren : bool = false
Tags
setupForUser()
Set up the full filesystem for a specified user.
public
setupForUser(IUser $user) : void
Parameters
- $user : IUser
Tags
tearDown()
Tear down all file systems to free some memory.
public
tearDown() : void