ICustomTemplateProvider.php 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2021 Julius Härtl <jus@bitgrid.net>
  5. *
  6. * @author Julius Härtl <jus@bitgrid.net>
  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\Template;
  25. use OCP\Files\File;
  26. /**
  27. * @since 21.0.0
  28. */
  29. interface ICustomTemplateProvider {
  30. /**
  31. * Return a list of additional templates that the template provider is offering
  32. *
  33. * @return File[]
  34. * @since 21.0.0
  35. */
  36. public function getCustomTemplates(string $mimetype): array;
  37. /**
  38. * Return the file for a given template id
  39. *
  40. * @param string $template identifier of the template
  41. * @return File
  42. * @since 21.0.0
  43. */
  44. public function getCustomTemplate(string $template): File;
  45. }