You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

55 lines
1.4 KiB

3 years ago
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2019 Arthur Schiwon <blizzz@arthur-schiwon.de>
  5. *
  6. * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
  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\WorkflowEngine;
  25. /**
  26. * Interface IEntityEvent
  27. *
  28. * represents an entitiy event that is dispatched via EventDispatcher
  29. *
  30. *
  31. * @since 18.0.0
  32. */
  33. interface IEntityEvent {
  34. /**
  35. * returns a translated name to be presented in the web interface.
  36. *
  37. * Example: "created" (en), "kreita" (eo)
  38. *
  39. * @since 18.0.0
  40. */
  41. public function getDisplayName(): string;
  42. /**
  43. * returns the event name that is emitted by the EventDispatcher, e.g.:
  44. *
  45. * Example: "OCA\MyApp\Factory\Cats::postCreated"
  46. *
  47. * @since 18.0.0
  48. */
  49. public function getEventName(): string;
  50. }