ICachedMountInfo.php 1.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2016, ownCloud, Inc.
  4. *
  5. * @author Robin Appelman <robin@icewind.nl>
  6. * @author Roeland Jago Douma <roeland@famdouma.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\Files\Node;
  25. use OCP\IUser;
  26. /**
  27. * Holds information about a mount for a user
  28. *
  29. * @since 9.0.0
  30. */
  31. interface ICachedMountInfo {
  32. /**
  33. * @return IUser
  34. * @since 9.0.0
  35. */
  36. public function getUser();
  37. /**
  38. * @return int the numeric storage id of the mount
  39. * @since 9.0.0
  40. */
  41. public function getStorageId();
  42. /**
  43. * @return int the fileid of the root of the mount
  44. * @since 9.0.0
  45. */
  46. public function getRootId();
  47. /**
  48. * @return Node the root node of the mount
  49. * @since 9.0.0
  50. */
  51. public function getMountPointNode();
  52. /**
  53. * @return string the mount point of the mount for the user
  54. * @since 9.0.0
  55. */
  56. public function getMountPoint();
  57. /**
  58. * Get the id of the configured mount
  59. *
  60. * @return int|null mount id or null if not applicable
  61. * @since 9.1.0
  62. */
  63. public function getMountId();
  64. /**
  65. * Get the internal path (within the storage) of the root of the mount
  66. *
  67. * @return string
  68. * @since 11.0.0
  69. */
  70. public function getRootInternalPath();
  71. }