ATemplate.php 1.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768
  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 JsonSerializable;
  25. /**
  26. * Class ATemplate
  27. *
  28. * @since 18.0.0
  29. */
  30. abstract class ATemplate implements JsonSerializable {
  31. /**
  32. * Return a unique id so the app can identify the template
  33. *
  34. * @since 18.0.0
  35. * @return string
  36. */
  37. abstract public function getId(): string;
  38. /**
  39. * Return a title that is displayed to the user
  40. *
  41. * @since 18.0.0
  42. * @return string
  43. */
  44. abstract public function getTitle(): string;
  45. /**
  46. * Return a link to the template preview image
  47. *
  48. * @since 18.0.0
  49. * @return string
  50. */
  51. abstract public function getPreview(): string;
  52. /**
  53. * @since 18.0.0
  54. */
  55. public function jsonSerialize(): array {
  56. return [
  57. 'id' => $this->getId(),
  58. 'title' => $this->getTitle(),
  59. 'preview' => $this->getPreview(),
  60. ];
  61. }
  62. }