IEventDispatcher.php 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright 2019 Christoph Wurst <christoph@winzerhof-wurst.at>
  5. *
  6. * @author 2019 Christoph Wurst <christoph@winzerhof-wurst.at>
  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. namespace OCP\EventDispatcher;
  24. /**
  25. * Event dispatcher service of Nextcloud
  26. *
  27. * @since 17.0.0
  28. */
  29. interface IEventDispatcher {
  30. /**
  31. * @param string $eventName preferably the fully-qualified class name of the Event sub class
  32. * @param callable $listener the object that is invoked when a matching event is dispatched
  33. * @param int $priority
  34. *
  35. * @since 17.0.0
  36. */
  37. public function addListener(string $eventName, callable $listener, int $priority = 0): void;
  38. /**
  39. * @param string $eventName preferably the fully-qualified class name of the Event sub class to listen for
  40. * @param string $className fully qualified class name (or ::class notation) of a \OCP\EventDispatcher\IEventListener that can be built by the DI container
  41. * @param int $priority
  42. *
  43. * @since 17.0.0
  44. */
  45. public function addServiceListener(string $eventName, string $className, int $priority = 0): void;
  46. /**
  47. * @param string $eventName
  48. * @param Event $event
  49. *
  50. * @since 17.0.0
  51. */
  52. public function dispatch(string $eventName, Event $event): void;
  53. }