IPublicShareTemplateProvider.php 1.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2023 Louis Chemineau <louis@chmn.me>
  5. *
  6. * @license GNU AGPL version 3 or any later version
  7. *
  8. * This program is free software: you can redistribute it and/or modify
  9. * it under the terms of the GNU Affero General Public License as
  10. * published by the Free Software Foundation, either version 3 of the
  11. * License, or (at your option) any later version.
  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
  19. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  20. *
  21. */
  22. namespace OCP\Share;
  23. use OCP\AppFramework\Http\TemplateResponse;
  24. /**
  25. * @since 26.0.0
  26. */
  27. interface IPublicShareTemplateProvider {
  28. /**
  29. * Returns whether the provider can respond for the given share.
  30. * @since 26.0.0
  31. */
  32. public function shouldRespond(IShare $share): bool;
  33. /**
  34. * Returns the a template for a given share.
  35. * @since 26.0.0
  36. */
  37. public function renderPage(IShare $share, string $token, string $path): TemplateResponse;
  38. }