Nextcloud PHP API (master)

BeforeUserLoggedInEvent extends Event
in package

Base event class for the event dispatcher service

Tags
since
18.0.0

Table of Contents

Properties

$backend  : IApacheBackend|null
$password  : string|null
$propagationStopped  : bool
$username  : string

Methods

__construct()  : mixed
Compatibility constructor
getBackend()  : IApacheBackend|null
return backend if available (or null)
getPassword()  : string|null
getUsername()  : string
returns the login name, which must not necessarily match to a user ID
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(string $username, string|null $password[, IApacheBackend|null $backend = null ]) : mixed
Parameters
$username : string
$password : string|null
$backend : IApacheBackend|null = null
Tags
since
18.0.0
since
26.0.0

password can be null

getPassword()

public getPassword() : string|null
Tags
since
18.0.0
since
26.0.0

value can be null

Return values
string|null

getUsername()

returns the login name, which must not necessarily match to a user ID

public getUsername() : string
Tags
since
18.0.0
Return values
string

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