QuilldEvent events
8 FeatherPanel plugin events on QuilldEvent (8 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.
Setup
Import QuilldEvent 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\QuilldEvent;
class MyPlugin implements AppPlugin
{
public static function processEvents(PluginEvents $event): void
{
$event->on(QuilldEvent::onQuilldInstallRetrieved(), function ($webspace, $install): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:quilld:install:retrieved ' . json_encode(['webspace' => $webspace, 'install' => $install]));
});
}
public static function pluginInstall(): void
{
}
public static function pluginUninstall(): void
{
}
}QuilldEvent::onQuilldActivityLogged()
Docblock: array activity.
| # | Payload key | Listener parameter | Type |
|---|---|---|---|
| 1 | processed_count | $processedCount | int |
When it fires (1 site)
QuilldActivityController::logActivityviaemitPluginEvent()POST /api/quilld-remote/activity
$event->on(QuilldEvent::onQuilldActivityLogged(), function ($processedCount): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:quilld:activity:logged ' . json_encode(['processed_count' => $processedCount]));
});QuilldEvent::onQuilldConfigRetrieved()
Docblock: array config. (the emitter passes 2 values, see the table)
| # | Payload key | Listener parameter | Type |
|---|---|---|---|
| 1 | web_node_id | $webNodeId | not declared |
| 2 | panel_url | $panelUrl | not declared |
When it fires (1 site)
FeatherQuilldConfigController::getConfigviaemitPluginEvent()GET /api/quilld-remote/config
$event->on(QuilldEvent::onQuilldConfigRetrieved(), function ($webNodeId, $panelUrl): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:quilld:config:retrieved');
});QuilldEvent::onQuilldInstallCompleted()
Docblock: array webspace. (the emitter passes 4 values, see the table)
| # | Payload key | Listener parameter | Type |
|---|---|---|---|
| 1 | webspace | $webspace | not declared |
| 2 | successful | $successful | bool |
| 3 | reinstall | $reinstall | not declared |
| 4 | status | $status | not declared |
When it fires (1 site)
$event->on(QuilldEvent::onQuilldInstallCompleted(), function ($webspace, $successful, $reinstall, $status): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:quilld:install:completed ' . json_encode(['successful' => $successful]));
});QuilldEvent::onQuilldInstallRetrieved()
Docblock: array webspace, array install.
| # | Payload key | Listener parameter | Type |
|---|---|---|---|
| 1 | webspace | $webspace | arrayfrom docblock |
| 2 | install | $install | arrayfrom docblock |
When it fires (1 site)
$event->on(QuilldEvent::onQuilldInstallRetrieved(), function ($webspace, $install): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:quilld:install:retrieved ' . json_encode(['webspace' => $webspace, 'install' => $install]));
});QuilldEvent::onQuilldSftpAuthenticated()
Docblock: array auth context. (the emitter passes 3 values, see the table)
| # | Payload key | Listener parameter | Type |
|---|---|---|---|
| 1 | webspace_uuid | $webspaceUuid | not declared |
| 2 | user_uuid | $userUuid | not declared |
| 3 | permissions | $permissions | not declared |
When it fires (1 site)
SftpAuthController::authenticateviaemitPluginEvent()
$event->on(QuilldEvent::onQuilldSftpAuthenticated(), function ($webspaceUuid, $userUuid, $permissions): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:quilld:sftp:authenticated');
});QuilldEvent::onQuilldTransferStatusReported()
Docblock: array transfer. (the emitter passes 3 values, see the table)
| # | Payload key | Listener parameter | Type |
|---|---|---|---|
| 1 | webspace_uuid | $webspaceUuid | string |
| 2 | successful | $successful | bool |
| 3 | error | $error | bool |
When it fires (1 site)
FeatherQuilldTransferController::postStatusviaemitPluginEvent()POST /api/quilld-remote/transfers/{uuid}
$event->on(QuilldEvent::onQuilldTransferStatusReported(), function ($webspaceUuid, $successful, $error): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:quilld:transfer:status ' . json_encode(['webspace_uuid' => $webspaceUuid, 'successful' => $successful, 'error' => $error]));
});QuilldEvent::onQuilldWebSpaceRetrieved()
Docblock: array webspace.
| # | Payload key | Listener parameter | Type |
|---|---|---|---|
| 1 | webspace | $webspace | arrayfrom docblock |
When it fires (1 site)
FeatherQuilldWebSpaceController::getWebSpaceviaemitPluginEvent()GET /api/quilld-remote/webspaces/{uuid}
$event->on(QuilldEvent::onQuilldWebSpaceRetrieved(), function ($webspace): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:quilld:webspace:retrieved ' . json_encode(['webspace' => $webspace]));
});QuilldEvent::onQuilldWebSpaceUpdated()
Docblock: array webspace.
| # | Payload key | Listener parameter | Type |
|---|---|---|---|
| 1 | webspace | $webspace | arrayfrom docblock |
When it fires (1 site)
FeatherQuilldWebSpaceController::patchWebSpaceviaemitPluginEvent()PATCH /api/quilld-remote/webspaces/{uuid}
$event->on(QuilldEvent::onQuilldWebSpaceUpdated(), function ($webspace): void {
App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:quilld:webspace:updated ' . json_encode(['webspace' => $webspace]));
});