IMountProviderCollection.php 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2016, ownCloud, Inc.
  4. *
  5. * @author Morris Jobke <hey@morrisjobke.de>
  6. * @author Robin Appelman <robin@icewind.nl>
  7. *
  8. * @license AGPL-3.0
  9. *
  10. * This code is free software: you can redistribute it and/or modify
  11. * it under the terms of the GNU Affero General Public License, version 3,
  12. * as published by the Free Software Foundation.
  13. *
  14. * This program is distributed in the hope that it will be useful,
  15. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17. * GNU Affero General Public License for more details.
  18. *
  19. * You should have received a copy of the GNU Affero General Public License, version 3,
  20. * along with this program. If not, see <http://www.gnu.org/licenses/>
  21. *
  22. */
  23. namespace OCP\Files\Config;
  24. use OCP\IUser;
  25. /**
  26. * Manages the different mount providers
  27. * @since 8.0.0
  28. */
  29. interface IMountProviderCollection {
  30. /**
  31. * Get all configured mount points for the user
  32. *
  33. * @param \OCP\IUser $user
  34. * @return \OCP\Files\Mount\IMountPoint[]
  35. * @since 8.0.0
  36. */
  37. public function getMountsForUser(IUser $user);
  38. /**
  39. * Get the configured home mount for this user
  40. *
  41. * @param \OCP\IUser $user
  42. * @return \OCP\Files\Mount\IMountPoint
  43. * @since 9.1.0
  44. */
  45. public function getHomeMountForUser(IUser $user);
  46. /**
  47. * Add a provider for mount points
  48. *
  49. * @param \OCP\Files\Config\IMountProvider $provider
  50. * @since 8.0.0
  51. */
  52. public function registerProvider(IMountProvider $provider);
  53. /**
  54. * Add a filter for mounts
  55. *
  56. * @param callable $filter (IMountPoint $mountPoint, IUser $user) => boolean
  57. * @since 14.0.0
  58. */
  59. public function registerMountFilter(callable $filter);
  60. /**
  61. * Add a provider for home mount points
  62. *
  63. * @param \OCP\Files\Config\IHomeMountProvider $provider
  64. * @since 9.1.0
  65. */
  66. public function registerHomeProvider(IHomeMountProvider $provider);
  67. /**
  68. * Get the mount cache which can be used to search for mounts without setting up the filesystem
  69. *
  70. * @return IUserMountCache
  71. * @since 9.0.0
  72. */
  73. public function getMountCache();
  74. }