share_backend_file_dependent.php 1.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243
  1. <?php
  2. /**
  3. * @author Joas Schilling <nickvergessen@owncloud.com>
  4. * @author Morris Jobke <hey@morrisjobke.de>
  5. *
  6. * @copyright Copyright (c) 2015, ownCloud, Inc.
  7. * @license AGPL-3.0
  8. *
  9. * This code is free software: you can redistribute it and/or modify
  10. * it under the terms of the GNU Affero General Public License, version 3,
  11. * as published by the Free Software Foundation.
  12. *
  13. * This program is distributed in the hope that it will be useful,
  14. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. * GNU Affero General Public License for more details.
  17. *
  18. * You should have received a copy of the GNU Affero General Public License, version 3,
  19. * along with this program. If not, see <http://www.gnu.org/licenses/>
  20. *
  21. */
  22. // use OCP namespace for all classes that are considered public.
  23. // This means that they should be used by apps instead of the internal ownCloud classes
  24. namespace OCP;
  25. /**
  26. * Interface for share backends that share content that is dependent on files.
  27. * Extends the Share_Backend interface.
  28. * @since 5.0.0
  29. */
  30. interface Share_Backend_File_Dependent extends Share_Backend {
  31. /**
  32. * Get the file path of the item
  33. * @param string $itemSource
  34. * @param string $uidOwner User that is the owner of shared item
  35. * @return string|false
  36. * @since 5.0.0
  37. */
  38. public function getFilePath($itemSource, $uidOwner);
  39. }