Nextcloud PHP API (master)

VerifyMountPointEvent extends Event
in package

Base event class for the event dispatcher service

Tags
since
19.0.0

Table of Contents

Properties

$createParent  : bool
$parent  : string
$share  : IShare
$user  : IUser
$view  : View

Methods

__construct()  : mixed
Compatibility constructor
createParent()  : bool
Whether the parent folder should be created if missing.
getParent()  : string
The parent folder where the share is placed, as relative path to the users home directory.
getShare()  : IShare
getUser()  : IUser
getView()  : View
isPropagationStopped()  : bool
{@inheritDoc}
setCreateParent()  : void
setParent()  : void
stopPropagation()  : void
Stops the propagation of the event to further event listeners

Properties

Methods

__construct()

Compatibility constructor

public __construct(IShare $share, View $view, string $parent, IUser $user) : mixed
Parameters
$share : IShare
$view : View
$parent : string
$user : IUser
Tags
since
19.0.0

createParent()

Whether the parent folder should be created if missing.

public createParent() : bool

If set for false (the default), and the parent folder doesn't exist already, the share will be moved to the default share folder instead.

Tags
since
34.0.0
Return values
bool

getParent()

The parent folder where the share is placed, as relative path to the users home directory.

public getParent() : string
Tags
since
19.0.0
Return values
string

getView()

public getView() : View
Tags
since
19.0.0
depecated

34.0.0 Get the user folder for $this->getUser() instead

Return values
View

isPropagationStopped()

{@inheritDoc}

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

setCreateParent()

public setCreateParent(bool $create) : void
Parameters
$create : bool
Tags
since
34.0.0

setParent()

public setParent(string $parent) : void
Parameters
$parent : string
Tags
since
19.0.0

stopPropagation()

Stops the propagation of the event to further event listeners

public stopPropagation() : void
Tags
since
22.0.0

        
On this page

Search results