ISimpleRoot.php 1.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  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. * @package OCP\Files\SimpleFS
  31. * @since 11.0.0
  32. */
  33. interface ISimpleRoot {
  34. /**
  35. * Get the folder with name $name
  36. *
  37. * @param string $name
  38. * @return ISimpleFolder
  39. * @throws NotFoundException
  40. * @throws \RuntimeException
  41. * @since 11.0.0
  42. */
  43. public function getFolder(string $name): ISimpleFolder;
  44. /**
  45. * Get all the Folders
  46. *
  47. * @return ISimpleFolder[]
  48. * @throws NotFoundException
  49. * @throws \RuntimeException
  50. * @since 11.0.0
  51. */
  52. public function getDirectoryListing(): array;
  53. /**
  54. * Create a new folder named $name
  55. *
  56. * @param string $name
  57. * @return ISimpleFolder
  58. * @throws NotPermittedException
  59. * @throws \RuntimeException
  60. * @since 11.0.0
  61. */
  62. public function newFolder(string $name): ISimpleFolder;
  63. }