DatabasesEvent events
11 FeatherPanel plugin events on DatabasesEvent (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. 8 of these events are declared but no code emits them yet; they are marked not emitted.
Setup
Import DatabasesEvent 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\DatabasesEvent;
class MyPlugin implements AppPlugin
{
public static function processEvents(PluginEvents $event): void
{
$event->on(DatabasesEvent::onDatabaseDeleted(), function ($database, $deletedBy): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:databases:database:deleted ' . json_encode(['database' => $database, 'deleted_by' => $deletedBy]));
});
}
public static function pluginInstall(): void
{
}
public static function pluginUninstall(): void
{
}
}DatabasesEvent::onDatabasesByNodeRetrieved()
Docblock: int node id, array databases.
$event->on(DatabasesEvent::onDatabasesByNodeRetrieved(), function (...$args): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:databases:by:node:retrieved ' . json_encode($args));
});No code emits this event yet, so the arguments are unknown. The listener accepts any.
DatabasesEvent::onDatabaseConnectionTested()
Docblock: array connection data, array test results.
$event->on(DatabasesEvent::onDatabaseConnectionTested(), function (...$args): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:databases:connection:tested ' . json_encode($args));
});No code emits this event yet, so the arguments are unknown. The listener accepts any.
DatabasesEvent::onDatabaseConnectionError()
Docblock: int database id, string error message.
$event->on(DatabasesEvent::onDatabaseConnectionError(), function (...$args): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:databases:database:connection:error ' . json_encode($args));
});No code emits this event yet, so the arguments are unknown. The listener accepts any.
DatabasesEvent::onDatabaseCreated()
Docblock: array database data. (the emitter passes 3 values, see the table)
| # | Payload key | Listener parameter | Type |
|---|---|---|---|
| 1 | database_id | $databaseId | not declared |
| 2 | database_data | $databaseData | not declared |
| 3 | created_by | $createdBy | not declared |
When it fires (1 site)
$event->on(DatabasesEvent::onDatabaseCreated(), function ($databaseId, $databaseData, $createdBy): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:databases:database:created');
});DatabasesEvent::onDatabaseDeleted()
Docblock: int database id, array database data.
| # | Payload key | Listener parameter | Type |
|---|---|---|---|
| 1 | database | $database | intfrom docblock |
| 2 | deleted_by | $deletedBy | arrayfrom docblock |
When it fires (1 site)
$event->on(DatabasesEvent::onDatabaseDeleted(), function ($database, $deletedBy): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:databases:database:deleted ' . json_encode(['database' => $database, 'deleted_by' => $deletedBy]));
});DatabasesEvent::onDatabaseHealthChecked()
Docblock: int database id, array health data.
$event->on(DatabasesEvent::onDatabaseHealthChecked(), function (...$args): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:databases:database:health:checked ' . json_encode($args));
});No code emits this event yet, so the arguments are unknown. The listener accepts any.
DatabasesEvent::onDatabaseNotFound()
Docblock: int database id, string error message.
$event->on(DatabasesEvent::onDatabaseNotFound(), function (...$args): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:databases:database:not:found ' . json_encode($args));
});No code emits this event yet, so the arguments are unknown. The listener accepts any.
DatabasesEvent::onDatabaseRetrieved()
Docblock: int database id, array database data.
$event->on(DatabasesEvent::onDatabaseRetrieved(), function (...$args): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:databases:database:retrieved ' . json_encode($args));
});No code emits this event yet, so the arguments are unknown. The listener accepts any.
DatabasesEvent::onDatabaseUpdated()
Docblock: int database id, array old data, array new data.
| # | Payload key | Listener parameter | Type |
|---|---|---|---|
| 1 | database | $database | intfrom docblock |
| 2 | updated_data | $updatedData | arrayfrom docblock |
| 3 | updated_by | $updatedBy | arrayfrom docblock |
When it fires (1 site)
$event->on(DatabasesEvent::onDatabaseUpdated(), function ($database, $updatedData, $updatedBy): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:databases:database:updated ' . json_encode(['database' => $database, 'updated_data' => $updatedData, 'updated_by' => $updatedBy]));
});DatabasesEvent::onDatabasesError()
Docblock: string error message, array context.
$event->on(DatabasesEvent::onDatabasesError(), function (...$args): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:databases:error ' . json_encode($args));
});No code emits this event yet, so the arguments are unknown. The listener accepts any.
DatabasesEvent::onDatabasesRetrieved()
Docblock: array databases list.
$event->on(DatabasesEvent::onDatabasesRetrieved(), function (...$args): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:admin:databases:retrieved ' . json_encode($args));
});No code emits this event yet, so the arguments are unknown. The listener accepts any.