You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

67 lines
1.7 KiB

3 years ago
  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. * @param string $name
  37. * @return ISimpleFolder
  38. * @throws NotFoundException
  39. * @throws \RuntimeException
  40. * @since 11.0.0
  41. */
  42. public function getFolder(string $name): ISimpleFolder;
  43. /**
  44. * Get all the Folders
  45. *
  46. * @return ISimpleFolder[]
  47. * @throws NotFoundException
  48. * @throws \RuntimeException
  49. * @since 11.0.0
  50. */
  51. public function getDirectoryListing(): array;
  52. /**
  53. * Create a new folder named $name
  54. *
  55. * @param string $name
  56. * @return ISimpleFolder
  57. * @throws NotPermittedException
  58. * @throws \RuntimeException
  59. * @since 11.0.0
  60. */
  61. public function newFolder(string $name): ISimpleFolder;
  62. }