Nextcloud PHP API (master)

SabrePluginEvent extends Event
in package

Base event class for the event dispatcher service

Tags
since
8.2.0

Table of Contents

Properties

$message  : string
$server  : Server
$statusCode  : int
$propagationStopped  : bool

Methods

__construct()  : mixed
Compatibility constructor
getMessage()  : string
getServer()  : null|Server
getStatusCode()  : int
isPropagationStopped()  : bool
{@inheritDoc}
setMessage()  : self
setStatusCode()  : self
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 $server = null ]) : mixed
Parameters
$server : mixed = null
Tags
since
8.2.0

getMessage()

public getMessage() : string
Tags
since
8.2.0
Return values
string

getServer()

public getServer() : null|Server
Tags
since
9.0.0
Return values
null|Server

getStatusCode()

public getStatusCode() : int
Tags
since
8.2.0
Return values
int

isPropagationStopped()

{@inheritDoc}

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

setMessage()

public setMessage(string $message) : self
Parameters
$message : string
Tags
since
8.2.0
Return values
self

setStatusCode()

public setStatusCode(int $statusCode) : self
Parameters
$statusCode : int
Tags
since
8.2.0
Return values
self

stopPropagation()

Stops the propagation of the event to further event listeners

public stopPropagation() : void
Tags
since
22.0.0

        
On this page

Search results