summaryrefslogtreecommitdiffstats
path: root/lib/public/Files/Mount/IMountManager.php
blob: 43a771c07ce820996c9ef0aa2bd4b321256bcccf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
<?php

declare(strict_types=1);
/**
 * SPDX-FileCopyrightText: 2016-2024 Nextcloud GmbH and Nextcloud contributors
 * SPDX-FileCopyrightText: 2016 ownCloud, Inc.
 * SPDX-License-Identifier: AGPL-3.0-only
 */
namespace OCP\Files\Mount;

use OCP\Files\Config\ICachedMountInfo;

/**
 * Interface IMountManager
 *
 * Manages all mounted storages in the system
 * @since 8.2.0
 */
interface IMountManager {
	/**
	 * Add a new mount
	 *
	 * @param IMountPoint $mount
	 * @since 8.2.0
	 */
	public function addMount(IMountPoint $mount);

	/**
	 * Remove a mount
	 *
	 * @param string $mountPoint
	 * @since 8.2.0
	 */
	public function removeMount(string $mountPoint);

	/**
	 * Change the location of a mount
	 *
	 * @param string $mountPoint
	 * @param string $target
	 * @since 8.2.0
	 */
	public function moveMount(string $mountPoint, string $target);

	/**
	 * Find the mount for $path
	 *
	 * @param string $path
	 * @return IMountPoint
	 * @since 8.2.0
	 */
	public function find(string $path): ?IMountPoint;

	/**
	 * Find all mounts in $path
	 *
	 * @param string $path
	 * @return IMountPoint[]
	 * @since 8.2.0
	 */
	public function findIn(string $path): array;

	/**
	 * Remove all registered mounts
	 *
	 * @since 8.2.0
	 */
	public function clear();

	/**
	 * Find mounts by storage id
	 *
	 * @param string $id
	 * @return IMountPoint[]
	 * @since 8.2.0
	 */
	public function findByStorageId(string $id): array;

	/**
	 * @return IMountPoint[]
	 * @since 8.2.0
	 */
	public function getAll(): array;

	/**
	 * Find mounts by numeric storage id
	 *
	 * @param int $id
	 * @return IMountPoint[]
	 * @since 8.2.0
	 */
	public function findByNumericId(int $id): array;

	/**
	 * Return the mount matching a cached mount info (or mount file info)
	 *
	 * @param ICachedMountInfo $info
	 *
	 * @return IMountPoint|null
	 * @since 28.0.0
	 */
	public function getMountFromMountInfo(ICachedMountInfo $info): ?IMountPoint;
}