ACreateEmpty.php 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2019 Julius Härtl <jus@bitgrid.net>
  4. *
  5. * @author Julius Härtl <jus@bitgrid.net>
  6. *
  7. * @license GNU AGPL version 3 or any later version
  8. *
  9. * This program is free software: you can redistribute it and/or modify
  10. * it under the terms of the GNU Affero General Public License as
  11. * published by the Free Software Foundation, either version 3 of the
  12. * License, or (at your option) any later version.
  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
  20. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  21. *
  22. */
  23. namespace OCP\DirectEditing;
  24. use OCP\Files\File;
  25. /**
  26. * @since 18.0.0
  27. */
  28. abstract class ACreateEmpty {
  29. /**
  30. * Unique id for the creator to filter templates
  31. *
  32. * e.g. document/spreadsheet/presentation
  33. *
  34. * @since 18.0.0
  35. * @return string
  36. */
  37. abstract public function getId(): string;
  38. /**
  39. * Descriptive name for the create action
  40. *
  41. * e.g Create a new document
  42. *
  43. * @since 18.0.0
  44. * @return string
  45. */
  46. abstract public function getName(): string;
  47. /**
  48. * Default file extension for the new file
  49. *
  50. * @since 18.0.0
  51. * @return string
  52. */
  53. abstract public function getExtension(): string;
  54. /**
  55. * Mimetype of the resulting created file
  56. *
  57. * @since 18.0.0
  58. * @return string
  59. */
  60. abstract public function getMimetype(): string;
  61. /**
  62. * Add content when creating empty files
  63. *
  64. * @since 18.0.0
  65. * @param File $file
  66. */
  67. public function create(File $file, ?string $creatorId = null, ?string $templateId = null): void {
  68. }
  69. }