0
0
mirror of https://github.com/nextcloud/server.git synced 2024-12-29 00:18:42 +00:00
nextcloud_server/lib/public/EventDispatcher/ABroadcastedEvent.php
Andy Scherzinger dae7c159f7
chore: Add SPDX header
Signed-off-by: Andy Scherzinger <info@andy-scherzinger.de>
2024-05-24 13:11:22 +02:00

54 lines
924 B
PHP

<?php
declare(strict_types=1);
/**
* SPDX-FileCopyrightText: 2019 Nextcloud GmbH and Nextcloud contributors
* SPDX-License-Identifier: AGPL-3.0-or-later
*/
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;
}
}