Share_Backend_Collection.php 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2016, ownCloud, Inc.
  4. *
  5. * @author Joas Schilling <coding@schilljs.com>
  6. * @author Morris Jobke <hey@morrisjobke.de>
  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. // use OCP namespace for all classes that are considered public.
  24. // This means that they should be used by apps instead of the internal ownCloud classes
  25. namespace OCP;
  26. /**
  27. * Interface for collections of of items implemented by another share backend.
  28. * Extends the Share_Backend interface.
  29. * @since 5.0.0
  30. */
  31. interface Share_Backend_Collection extends Share_Backend {
  32. /**
  33. * Get the sources of the children of the item
  34. * @param string $itemSource
  35. * @return array Returns an array of children each inside an array with the keys: source, target, and file_path if applicable
  36. * @since 5.0.0
  37. */
  38. public function getChildren($itemSource);
  39. }