Share_Backend_File_Dependent.php 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  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. * @author Roeland Jago Douma <roeland@famdouma.nl>
  8. *
  9. * @license AGPL-3.0
  10. *
  11. * This code is free software: you can redistribute it and/or modify
  12. * it under the terms of the GNU Affero General Public License, version 3,
  13. * as published by the Free Software Foundation.
  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, version 3,
  21. * along with this program. If not, see <http://www.gnu.org/licenses/>
  22. *
  23. */
  24. // use OCP namespace for all classes that are considered public.
  25. // This means that they should be used by apps instead of the internal ownCloud classes
  26. namespace OCP;
  27. /**
  28. * Interface for share backends that share content that is dependent on files.
  29. * Extends the Share_Backend interface.
  30. * @since 5.0.0
  31. */
  32. interface Share_Backend_File_Dependent extends Share_Backend {
  33. /**
  34. * Get the file path of the item
  35. * @param string $itemSource
  36. * @param string $uidOwner User that is the owner of shared item
  37. * @return string|false
  38. * @since 5.0.0
  39. */
  40. public function getFilePath($itemSource, $uidOwner);
  41. }