1
0

ISimpleRoot.php 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2016 Roeland Jago Douma <roeland@famdouma.nl>
  4. *
  5. * @author Morris Jobke <hey@morrisjobke.de>
  6. * @author Roeland Jago Douma <roeland@famdouma.nl>
  7. *
  8. * @license GNU AGPL version 3 or any later version
  9. *
  10. * This program is free software: you can redistribute it and/or modify
  11. * it under the terms of the GNU Affero General Public License as
  12. * published by the Free Software Foundation, either version 3 of the
  13. * License, or (at your option) any later version.
  14. *
  15. * This program is distributed in the hope that it will be useful,
  16. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  18. * GNU Affero General Public License for more details.
  19. *
  20. * You should have received a copy of the GNU Affero General Public License
  21. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  22. *
  23. */
  24. namespace OCP\Files\SimpleFS;
  25. use OCP\Files\NotFoundException;
  26. use OCP\Files\NotPermittedException;
  27. /**
  28. * Interface ISimpleRoot
  29. *
  30. * @since 11.0.0
  31. */
  32. interface ISimpleRoot {
  33. /**
  34. * Get the folder with name $name
  35. *
  36. * @throws NotFoundException
  37. * @throws \RuntimeException
  38. * @since 11.0.0
  39. */
  40. public function getFolder(string $name): ISimpleFolder;
  41. /**
  42. * Get all the Folders
  43. *
  44. * @return ISimpleFolder[]
  45. * @throws NotFoundException
  46. * @throws \RuntimeException
  47. * @since 11.0.0
  48. */
  49. public function getDirectoryListing(): array;
  50. /**
  51. * Create a new folder named $name
  52. *
  53. * @throws NotPermittedException
  54. * @throws \RuntimeException
  55. * @since 11.0.0
  56. */
  57. public function newFolder(string $name): ISimpleFolder;
  58. }