1
0

IEntityEvent.php 740 B

12345678910111213141516171819202122232425262728293031323334353637
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * SPDX-FileCopyrightText: 2019 Nextcloud GmbH and Nextcloud contributors
  5. * SPDX-License-Identifier: AGPL-3.0-or-later
  6. */
  7. namespace OCP\WorkflowEngine;
  8. /**
  9. * Interface IEntityEvent
  10. *
  11. * represents an entity event that is dispatched via EventDispatcher
  12. *
  13. *
  14. * @since 18.0.0
  15. */
  16. interface IEntityEvent {
  17. /**
  18. * returns a translated name to be presented in the web interface.
  19. *
  20. * Example: "created" (en), "kreita" (eo)
  21. *
  22. * @since 18.0.0
  23. */
  24. public function getDisplayName(): string;
  25. /**
  26. * returns the event name that is emitted by the EventDispatcher, e.g.:
  27. *
  28. * Example: "OCA\MyApp\Factory\Cats::postCreated"
  29. *
  30. * @since 18.0.0
  31. */
  32. public function getEventName(): string;
  33. }