Nextcloud PHP API (stable18)

SabrePluginEvent extends Event

Base event class for the event dispatcher service

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

Tags
since
8.2.0

Table of Contents

$message  : string
$server  : Server
$statusCode  : int
__construct()  : mixed
Compatibility constructor
getMessage()  : string
getServer()  : null|Server
getStatusCode()  : int
setMessage()  : self
setStatusCode()  : self

Properties

Methods

__construct()

Compatibility constructor

public __construct([mixed $server = null ]) : 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.

Parameters
$server : mixed = null
Tags
since
8.2.0
Return values
mixed —

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 —

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 —

Search results