Nextcloud PHP API (master)

Event
in package
implements StoppableEventInterface

Base event class for the event dispatcher service

Typically this class isn't instantiated directly but sub classed for specific event types

This class extended \Symfony\Contracts\EventDispatcher\Event until 21.0, since 22.0.0 this class directly implements the PSR StoppableEventInterface and no longer relies on Symfony. This transition does not come with any changes in API, the class has the same methods and behavior before and after this change.

Tags
since
17.0.0

Table of Contents

Interfaces

StoppableEventInterface

Properties

$propagationStopped  : bool

Methods

__construct()  : mixed
Compatibility constructor
isPropagationStopped()  : bool
{@inheritDoc}
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

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