Nextcloud PHP API (master)

BeforePreferenceDeletedEvent extends Event
in package

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.

Attributes
#[Listenable]
$since: '25.0.0'

Table of Contents

Properties

$appId  : string
$configKey  : string
$userId  : string
$valid  : bool

Methods

__construct()  : mixed
Compatibility constructor
getAppId()  : string
getConfigKey()  : string
getUserId()  : string
isPropagationStopped()  : bool
{@inheritDoc}
isValid()  : bool
setValid()  : void
stopPropagation()  : void
Stops the propagation of the event to further event listeners

Properties

Methods

__construct()

Compatibility constructor

public __construct(string $userId, string $appId, string $configKey) : mixed
Parameters
$userId : string
$appId : string
$configKey : string
Tags
since
25.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