Nextcloud PHP API (master)

ABroadcastedEvent extends Event
in package
implements JsonSerializable

AbstractYes

Base event class for the event dispatcher service

Tags
since
18.0.0

Table of Contents

Interfaces

JsonSerializable

Properties

$broadcasted  : mixed
$propagationStopped  : bool

Methods

__construct()  : mixed
Compatibility constructor
broadcastAs()  : string
Get the name of the event, as received on the client-side
getUids()  : array<string|int, string>
isBroadcasted()  : bool
isPropagationStopped()  : bool
{@inheritDoc}
setBroadcasted()  : void
stopPropagation()  : void
Stops the propagation of the event to further event listeners

Properties

$propagationStopped

private bool $propagationStopped = false
Tags
since
22.0.0

Methods

__construct()

Compatibility constructor

public __construct() : mixed

In Nextcloud 17.0.0 this event class used a now deprecated/removed Symfony base class that had a constructor (with default arguments). To lower the risk of a breaking change (PHP won't allow parent constructor calls if there is none), this empty constructor's only purpose is to hopefully not break existing sub- classes of this class.

Tags
since
18.0.0

broadcastAs()

Get the name of the event, as received on the client-side

public broadcastAs() : string

Uses the fully qualified event class name by default

Tags
since
18.0.0
Return values
string

getUids()

public abstract getUids() : array<string|int, string>
Tags
since
18.0.0
Return values
array<string|int, string>

isBroadcasted()

public isBroadcasted() : bool
Tags
since
18.0.0
Return values
bool

isPropagationStopped()

{@inheritDoc}

public isPropagationStopped() : bool
Tags
since
22.0.0
see
StoppableEventInterface
Return values
bool

stopPropagation()

Stops the propagation of the event to further event listeners

public stopPropagation() : void
Tags
since
22.0.0

        
On this page

Search results