diff options
author | Christoph Wurst <christoph@winzerhof-wurst.at> | 2019-05-28 20:46:36 +0300 |
---|---|---|
committer | Christoph Wurst <christoph@winzerhof-wurst.at> | 2019-06-25 11:02:27 +0300 |
commit | 3174012adf3fde4de74efa12cfa7e480b874b295 (patch) | |
tree | bc58b99dc45b5adcdeaf30269e9a6eab2c853773 /lib/public/EventDispatcher | |
parent | 817bdc47c804ae8511ad3423eae216f6ccdee6c6 (diff) |
Add event dispatcher to OCP
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
Diffstat (limited to 'lib/public/EventDispatcher')
-rw-r--r-- | lib/public/EventDispatcher/Event.php | 40 | ||||
-rw-r--r-- | lib/public/EventDispatcher/IEventDispatcher.php | 61 | ||||
-rw-r--r-- | lib/public/EventDispatcher/IEventListener.php | 40 |
3 files changed, 141 insertions, 0 deletions
diff --git a/lib/public/EventDispatcher/Event.php b/lib/public/EventDispatcher/Event.php new file mode 100644 index 00000000000..7f8554d7a86 --- /dev/null +++ b/lib/public/EventDispatcher/Event.php @@ -0,0 +1,40 @@ +<?php + +declare(strict_types=1); + +/** + * @copyright 2019 Christoph Wurst <christoph@winzerhof-wurst.at> + * + * @author 2019 Christoph Wurst <christoph@winzerhof-wurst.at> + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + */ + +namespace OCP\EventDispatcher; + +use Symfony\Component\EventDispatcher\GenericEvent; + +/** + * Base event class for the event dispatcher service + * + * Typically this class isn't instantiated directly but sub classed for specific + * event types + * + * @since 17.0.0 + */ +class Event extends GenericEvent { + +} diff --git a/lib/public/EventDispatcher/IEventDispatcher.php b/lib/public/EventDispatcher/IEventDispatcher.php new file mode 100644 index 00000000000..af4d5316a7b --- /dev/null +++ b/lib/public/EventDispatcher/IEventDispatcher.php @@ -0,0 +1,61 @@ +<?php + +declare(strict_types=1); + +/** + * @copyright 2019 Christoph Wurst <christoph@winzerhof-wurst.at> + * + * @author 2019 Christoph Wurst <christoph@winzerhof-wurst.at> + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + */ + +namespace OCP\EventDispatcher; + +/** + * Event dispatcher service of Nextcloud + * + * @since 17.0.0 + */ +interface IEventDispatcher { + + /** + * @param string $eventName preferably the fully-qualified class name of the Event sub class + * @param callable $listener the object that is invoked when a matching event is dispatched + * @param int $priority + * + * @since 17.0.0 + */ + public function addListener(string $eventName, callable $listener, int $priority = 0): void; + + /** + * @param string $eventName preferably the fully-qualified class name of the Event sub class to listen for + * @param string $className fully qualified class name (or ::class notation) of a \OCP\EventDispatcher\IEventListener that can be built by the DI container + * @param int $priority + * + * @since 17.0.0 + */ + public function addServiceListener(string $eventName, string $className, int $priority = 0): void; + + /** + * @param string $eventName + * @param Event $event + * + * @since 17.0.0 + */ + public function dispatch(string $eventName, Event $event): void; + +} diff --git a/lib/public/EventDispatcher/IEventListener.php b/lib/public/EventDispatcher/IEventListener.php new file mode 100644 index 00000000000..5ecf31abc4a --- /dev/null +++ b/lib/public/EventDispatcher/IEventListener.php @@ -0,0 +1,40 @@ +<?php + +declare(strict_types=1); + +/** + * @copyright 2019 Christoph Wurst <christoph@winzerhof-wurst.at> + * + * @author 2019 Christoph Wurst <christoph@winzerhof-wurst.at> + * + * @license GNU AGPL version 3 or any later version + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU Affero General Public License as + * published by the Free Software Foundation, either version 3 of the + * License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Affero General Public License for more details. + * + * You should have received a copy of the GNU Affero General Public License + * along with this program. If not, see <http://www.gnu.org/licenses/>. + */ + +namespace OCP\EventDispatcher; + +/** + * @since 17.0.0 + */ +interface IEventListener { + + /** + * @param Event $event + * + * @since 17.0.0 + */ + public function handle(Event $event): void; + +} |