diff options
author | Christoph Wurst <christoph@winzerhof-wurst.at> | 2019-09-16 19:09:43 +0300 |
---|---|---|
committer | Roeland Jago Douma <roeland@famdouma.nl> | 2019-10-28 15:58:13 +0300 |
commit | d180a987149df30dacceb85b07d0bfbf9adc265e (patch) | |
tree | cba51fa719b50044bb8b370ba313df6c097bce40 /lib/public | |
parent | 908f13e9b961cafafe349d4906a6a8357d65b20f (diff) |
Make it possible to broadcast events to (web) clients
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
Diffstat (limited to 'lib/public')
-rw-r--r-- | lib/public/Broadcast/Events/IBroadcastEvent.php | 57 | ||||
-rw-r--r-- | lib/public/EventDispatcher/ABroadcastedEvent.php | 71 |
2 files changed, 128 insertions, 0 deletions
diff --git a/lib/public/Broadcast/Events/IBroadcastEvent.php b/lib/public/Broadcast/Events/IBroadcastEvent.php new file mode 100644 index 00000000000..0aa7ff45eec --- /dev/null +++ b/lib/public/Broadcast/Events/IBroadcastEvent.php @@ -0,0 +1,57 @@ +<?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\Broadcast\Events; + +use JsonSerializable; + +/** + * @since 18.0.0 + */ +interface IBroadcastEvent { + + /** + * @return string the name of the event + * @since 18.0.0 + */ + public function getName(): string; + + /** + * @return string[] + * @since 18.0.0 + */ + public function getUids(): array; + + /** + * @return JsonSerializable the data to be sent to the client + * @since 18.0.0 + */ + public function getPayload(): JsonSerializable; + + /** + * @since 18.0.0 + */ + public function setBroadcasted(): void; + +} diff --git a/lib/public/EventDispatcher/ABroadcastedEvent.php b/lib/public/EventDispatcher/ABroadcastedEvent.php new file mode 100644 index 00000000000..1c240b4fb73 --- /dev/null +++ b/lib/public/EventDispatcher/ABroadcastedEvent.php @@ -0,0 +1,71 @@ +<?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 JsonSerializable; + +/** + * @since 18.0.0 + */ +abstract class ABroadcastedEvent extends Event implements JsonSerializable { + + /** + * @since 18.0.0 + */ + private $broadcasted = false; + + /** + * Get the name of the event, as received on the client-side + * + * Uses the fully qualified event class name by default + * + * @return string + * @since 18.0.0 + */ + public function broadcastAs(): string { + return get_class($this); + } + + /** + * @return string[] + * @since 18.0.0 + */ + abstract public function getUids(): array; + + /** + * @since 18.0.0 + */ + public function setBroadcasted(): void { + $this->broadcasted = true; + } + + /** + * @since 18.0.0 + */ + public function isBroadcasted(): bool { + return $this->broadcasted; + } + +} |