View .md

ServerDatabaseEvent events

4 FeatherPanel plugin events on ServerDatabaseEvent (3 emitted by the core): the event names, the arguments each listener gets, where they fire and a PHP listener for each.

Last synced from FeatherPanel 15b94e9 on .

On this page

Part of the plugin events reference. Listeners get the payload values as positional arguments in the order shown, cannot cancel the action, and must catch their own exceptions. 1 of these events are declared but no code emits them yet; they are marked not emitted.

Setup

Import ServerDatabaseEvent in your entry class and register listeners in processEvents():

<?php

namespace App\Addons\myplugin;

use App\App;
use App\Plugins\AppPlugin;
use App\Plugins\PluginEvents;
use App\Plugins\Events\Events\ServerDatabaseEvent;

class MyPlugin implements AppPlugin
{
    public static function processEvents(PluginEvents $event): void
    {
        $event->on(ServerDatabaseEvent::onServerDatabaseUpdated(), function ($userUuid, $serverUuid, $databaseId): void {
            App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:user:server:database:updated ' . json_encode(['user_uuid' => $userUuid, 'server_uuid' => $serverUuid, 'database_id' => $databaseId]));
        });
    }

    public static function pluginInstall(): void
    {
    }

    public static function pluginUninstall(): void
    {
    }
}

ServerDatabaseEvent::onServerDatabaseCreated()

Name: featherpanel:user:server:database:createdemitted at 2 sitesCancel or modify: nodefinition

Docblock: string server uuid, array database data. (the emitter passes 3 values, see the table)

Same event name as ServerEvent::onServerDatabaseCreated(). A listener on either method receives the emits of both.

#Payload keyListener parameterType
1user_uuid$userUuidnot declared
2server_uuid$serverUuidnot declared
3database_id$databaseIdnot declared
When it fires (2 sites)
$event->on(ServerDatabaseEvent::onServerDatabaseCreated(), function ($userUuid, $serverUuid, $databaseId): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:user:server:database:created');
});

ServerDatabaseEvent::onServerDatabaseDeleted()

Name: featherpanel:user:server:database:deletedemitted at 3 sites2 payload shapesCancel or modify: nodefinition

Docblock: string server uuid, int database id. (the emitter passes 3 values, see the table)

Same event name as ServerEvent::onServerDatabaseDeleted(). A listener on either method receives the emits of both.

#Payload keyListener parameterType
1user_uuid$userUuidnot declared
2server_uuid$serverUuidnot declared
3database_id$databaseIdint
Arguments passedEmitted from
user_uuid, server_uuid, database_id
ServerDatabaseController::deleteServerDatabase
DeleteDatabaseTool::execute
user_uuid, server_uuid, database_id, bulk
ServerDatabaseController::bulkDeleteServerDatabases
When it fires (3 sites)
$event->on(ServerDatabaseEvent::onServerDatabaseDeleted(), function ($userUuid, $serverUuid, $databaseId, ...$rest): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:user:server:database:deleted ' . json_encode(['database_id' => $databaseId]));
});

ServerDatabaseEvent::onServerDatabaseError()

Name: featherpanel:user:server:database:errornot emittedCancel or modify: nodefinition

Docblock: string error message, array context.

$event->on(ServerDatabaseEvent::onServerDatabaseError(), function (...$args): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:user:server:database:error ' . json_encode($args));
});

No code emits this event yet, so the arguments are unknown. The listener accepts any.

ServerDatabaseEvent::onServerDatabaseUpdated()

Name: featherpanel:user:server:database:updatedemitted at 2 sitesCancel or modify: nodefinition

Docblock: string server uuid, int database id, array updated data.

Same event name as ServerEvent::onServerDatabaseUpdated(). A listener on either method receives the emits of both.

#Payload keyListener parameterType
1user_uuid$userUuidstringfrom docblock
2server_uuid$serverUuidintfrom docblock
3database_id$databaseIdint
When it fires (2 sites)
$event->on(ServerDatabaseEvent::onServerDatabaseUpdated(), function ($userUuid, $serverUuid, $databaseId): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:user:server:database:updated ' . json_encode(['user_uuid' => $userUuid, 'server_uuid' => $serverUuid, 'database_id' => $databaseId]));
});