1
0

IWidget.php 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2020 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\Dashboard;
  25. /**
  26. * Interface IWidget
  27. *
  28. * @since 20.0.0
  29. */
  30. interface IWidget {
  31. /**
  32. * @return string Unique id that identifies the widget, e.g. the app id
  33. * @since 20.0.0
  34. */
  35. public function getId(): string;
  36. /**
  37. * @return string User facing title of the widget
  38. * @since 20.0.0
  39. */
  40. public function getTitle(): string;
  41. /**
  42. * @return int Initial order for widget sorting
  43. * @since 20.0.0
  44. */
  45. public function getOrder(): int;
  46. /**
  47. * @return string css class that displays an icon next to the widget title
  48. * @since 20.0.0
  49. */
  50. public function getIconClass(): string;
  51. /**
  52. * @return string|null The absolute url to the apps own view
  53. * @since 20.0.0
  54. */
  55. public function getUrl(): ?string;
  56. /**
  57. * Execute widget bootstrap code like loading scripts and providing initial state
  58. * @since 20.0.0
  59. */
  60. public function load(): void;
  61. }