upstream/nextcloud
1
0
Fork 0
mirror of https://github.com/nextcloud/server.git synced 2026-05-28 04:32:30 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions 25

fix: clearify meaning of getMountsForPath arguments

Browse source 
Signed-off-by: Robin Appelman <robin@icewind.nl>
This commit is contained in:
Robin Appelman 2026-01-14 18:38:02 +01:00
parent abe5499e14
commit 83ac1c6030
1 changed files with 21 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
lib/public/Files/Config/IPartialMountProvider.php
View file

@ -20,6 +20,8 @@ use OCP\Files\Storage\IStorageFactory;
interface IPartialMountProvider extends IMountProvider {
/**
* Get the mounts for a user by path.
*
* Called during the Filesystem setup of a specific path.
*
* The provided arguments give information about the path being set up,
@ -29,15 +31,28 @@ interface IPartialMountProvider extends IMountProvider {
* Implementations should verify the MountProviderArgs and return the
* corresponding IMountPoint instances.
*
* @param string $path path for which the mounts are set up
* @param bool $forChildren when true, only child mounts for path should be returned
* @param MountProviderArgs[] $mountProviderArgs
* If the mount for one of the MountProviderArgs no longer exists, implementations
* should simply leave them out from the returned mounts.
*
* Implementations are allowed to, but not expected to, return more mounts than requested.
*
* The user for which the mounts are being setup can be found in the `mountInfo->getUser()`
* of a MountProviderArgs.
* All provided MountProviderArgs will always be for the same user.
*
* @param string $setupPathHint path for which the mounts are being set up.
* This might not be the same as the path of the expected mount(s).
* @param bool $forChildren when true, only child mounts for `$setupPathHint` were requested.
* The $mountProviderArgs will hold a list of expected child mounts
* @param non-empty-list<MountProviderArgs> $mountProviderArgs The data for the mount which should be provided.
* Contains the mount information and root-cache-entry
* for each mount the system knows about
* in the scope of the setup request.
* @param IStorageFactory $loader
* @return array<string, IMountPoint> IMountPoint instances, indexed by
* mount-point
* @return array<string, IMountPoint> IMountPoint instances, indexed by mount-point
*/
public function getMountsForPath(
string $path,
string $setupPathHint,
bool $forChildren,
array $mountProviderArgs,
IStorageFactory $loader,