2020interface IPartialMountProvider extends IMountProvider {
2121
2222 /**
23+ * Get the mounts for a user by path.
24+ *
2325 * Called during the Filesystem setup of a specific path.
2426 *
2527 * The provided arguments give information about the path being set up,
@@ -29,15 +31,28 @@ interface IPartialMountProvider extends IMountProvider {
2931 * Implementations should verify the MountProviderArgs and return the
3032 * corresponding IMountPoint instances.
3133 *
32- * @param string $path path for which the mounts are set up
33- * @param bool $forChildren when true, only child mounts for path should be returned
34- * @param MountProviderArgs[] $mountProviderArgs
34+ * If the mount for one of the MountProviderArgs no longer exists, implementations
35+ * should simply leave them out from the returned mounts.
36+ *
37+ * Implementations are allowed to, but not expected to, return more mounts than requested.
38+ *
39+ * The user for which the mounts are being setup can be found in the `mountInfo->getUser()`
40+ * of a MountProviderArgs.
41+ * All provided MountProviderArgs will always be for the same user.
42+ *
43+ * @param string $setupPathHint path for which the mounts are being set up.
44+ * This might not be the same as the path of the expected mount(s).
45+ * @param bool $forChildren when true, only child mounts for `$setupPathHint` were requested.
46+ * The $mountProviderArgs will hold a list of expected child mounts
47+ * @param non-empty-list<MountProviderArgs> $mountProviderArgs The data for the mount which should be provided.
48+ * Contains the mount information and root-cache-entry
49+ * for each mount the system knows about
50+ * in the scope of the setup request.
3551 * @param IStorageFactory $loader
36- * @return array<string, IMountPoint> IMountPoint instances, indexed by
37- * mount-point
52+ * @return array<string, IMountPoint> IMountPoint instances, indexed by mount-point
3853 */
3954 public function getMountsForPath (
40- string $ path ,
55+ string $ setupPathHint ,
4156 bool $ forChildren ,
4257 array $ mountProviderArgs ,
4358 IStorageFactory $ loader ,
0 commit comments