Nextcloud PHP API (master)

InstallationCompletedEvent extends Event
in package

Emitted when the Nextcloud installation has been completed successfully.

This event is dispatched after:

  • The database has been configured and migrations have run
  • The admin user has been created (if applicable)
  • Default apps have been installed
  • Background jobs have been configured
  • The system has been marked as installed

Apps can listen to this event to perform additional actions after installation, such as:

  • Sending notification emails
  • Triggering external APIs
  • Initializing app-specific data
  • Setting up integrations
Tags
since
33.0.0

Table of Contents

Properties

$adminEmail  : string|null
$adminUsername  : string|null
$dataDirectory  : string

Methods

__construct()  : mixed
Compatibility constructor
getAdminEmail()  : string|null
Get the admin email if configured
getAdminUsername()  : string|null
Get the admin username if an admin user was created
getDataDirectory()  : string
Get the configured data directory path
hasAdminUser()  : bool
Check if an admin user was created during installation
isPropagationStopped()  : bool
{@inheritDoc}
stopPropagation()  : void
Stops the propagation of the event to further event listeners

Properties

Methods

__construct()

Compatibility constructor

public __construct(string $dataDirectory[, string|null $adminUsername = null ][, string|null $adminEmail = null ]) : mixed
Parameters
$dataDirectory : string
$adminUsername : string|null = null
$adminEmail : string|null = null
Tags
since
33.0.0

getAdminEmail()

Get the admin email if configured

public getAdminEmail() : string|null
Tags
since
33.0.0
Return values
string|null

getAdminUsername()

Get the admin username if an admin user was created

public getAdminUsername() : string|null
Tags
since
33.0.0
Return values
string|null

getDataDirectory()

Get the configured data directory path

public getDataDirectory() : string
Tags
since
33.0.0
Return values
string

hasAdminUser()

Check if an admin user was created during installation

public hasAdminUser() : bool
Tags
since
33.0.0
Return values
bool

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