IRootFolder.php 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2016, ownCloud, Inc.
  4. *
  5. * @author Bernhard Posselt <dev@bernhard-posselt.com>
  6. * @author Christoph Wurst <christoph@winzerhof-wurst.at>
  7. * @author Julius Härtl <jus@bitgrid.net>
  8. * @author Morris Jobke <hey@morrisjobke.de>
  9. *
  10. * @license AGPL-3.0
  11. *
  12. * This code is free software: you can redistribute it and/or modify
  13. * it under the terms of the GNU Affero General Public License, version 3,
  14. * as published by the Free Software Foundation.
  15. *
  16. * This program is distributed in the hope that it will be useful,
  17. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19. * GNU Affero General Public License for more details.
  20. *
  21. * You should have received a copy of the GNU Affero General Public License, version 3,
  22. * along with this program. If not, see <http://www.gnu.org/licenses/>
  23. *
  24. */
  25. namespace OCP\Files;
  26. use OC\Hooks\Emitter;
  27. use OC\User\NoUserException;
  28. /**
  29. * Interface IRootFolder
  30. *
  31. * @since 8.0.0
  32. */
  33. interface IRootFolder extends Folder, Emitter {
  34. /**
  35. * Returns a view to user's files folder
  36. *
  37. * @param string $userId user ID
  38. * @return Folder
  39. * @throws NoUserException
  40. * @throws NotPermittedException
  41. *
  42. * @since 8.2.0
  43. */
  44. public function getUserFolder($userId);
  45. /**
  46. * Get a file or folder by fileid, inside a parent path
  47. *
  48. * @param int $id
  49. * @param string $path
  50. * @return Node[]
  51. *
  52. * @since 24.0.0
  53. */
  54. public function getByIdInPath(int $id, string $path);
  55. }