Settings

7 events in this category

stormnodes:admin:settings:setting:retrieved

Callback parameters: string setting name, array setting data.

onSettingRetrieved

Event Data Structure

This event receives the following data when emitted:

setting_data
setting_name

Emitted from:

backend/app/Controllers/Admin/SettingsController.php

Usage Example

use App\Plugins\PluginEvents;
use App\Plugins\Events\Events\SettingsEvent;

public static function processEvents(PluginEvents $evt): void
{
    $evt->on(SettingsEvent::onSettingRetrieved(), function ($settingData, $settingName) {
        // Handle stormnodes:admin:settings:setting:retrieved
        // Data keys: setting_data, setting_name
    });
}

stormnodes:admin:settings:category:retrieved

Callback parameters: string category, array settings.

onSettingsByCategoryRetrieved

Event Data Structure

This event receives the following data when emitted:

categories
category
category_config
settings

Emitted from:

backend/app/Controllers/Admin/SettingsController.php

Usage Example

use App\Plugins\PluginEvents;
use App\Plugins\Events\Events\SettingsEvent;

public static function processEvents(PluginEvents $evt): void
{
    $evt->on(SettingsEvent::onSettingsByCategoryRetrieved(), function ($categories, $category, $categoryConfig, $settings) {
        // Handle stormnodes:admin:settings:category:retrieved
        // Data keys: categories, category, category_config, settings
    });
}

stormnodes:admin:settings:error

Callback parameters: string error message, array context.

onSettingsError

Usage Example

use App\Plugins\PluginEvents;
use App\Plugins\Events\Events\SettingsEvent;

public static function processEvents(PluginEvents $evt): void
{
    $evt->on(SettingsEvent::onSettingsError(), function ($message, $context) {
        // Handle stormnodes:admin:settings:error
        // Parameters: string error message, array context.
    });
}

stormnodes:admin:settings:retrieved

Callback parameters: array settings data.

onSettingsRetrieved

Event Data Structure

This event receives the following data when emitted:

categories
organized_settings
settings

Emitted from:

backend/app/Controllers/Admin/SettingsController.php

Usage Example

use App\Plugins\PluginEvents;
use App\Plugins\Events\Events\SettingsEvent;

public static function processEvents(PluginEvents $evt): void
{
    $evt->on(SettingsEvent::onSettingsRetrieved(), function ($categories, $organizedSettings, $settings) {
        // Handle stormnodes:admin:settings:retrieved
        // Data keys: categories, organized_settings, settings
    });
}

stormnodes:admin:settings:updated

Callback parameters: array updated settings, array old values.

onSettingsUpdated

Event Data Structure

This event receives the following data when emitted:

settings_data
updated_settings
user

Emitted from:

backend/app/Controllers/Admin/SettingsController.php

Usage Example

use App\Plugins\PluginEvents;
use App\Plugins\Events\Events\SettingsEvent;

public static function processEvents(PluginEvents $evt): void
{
    $evt->on(SettingsEvent::onSettingsUpdated(), function ($settingsData, $updatedSettings, $user) {
        // Handle stormnodes:admin:settings:updated
        // Data keys: settings_data, updated_settings, user
    });
}

stormnodes:admin:settings:setting:updated

Callback parameters: string setting name, mixed old value, mixed new value.

onSettingUpdated

Usage Example

use App\Plugins\PluginEvents;
use App\Plugins\Events\Events\SettingsEvent;

public static function processEvents(PluginEvents $evt): void
{
    $evt->on(SettingsEvent::onSettingUpdated(), function ($name, $value, $value) {
        // Handle stormnodes:admin:settings:setting:updated
        // Parameters: string setting name, mixed old value, mixed new value.
    });
}

stormnodes:admin:settings:validation:error

Callback parameters: string setting name, string error message.

onSettingValidationError

Usage Example

use App\Plugins\PluginEvents;
use App\Plugins\Events\Events\SettingsEvent;

public static function processEvents(PluginEvents $evt): void
{
    $evt->on(SettingsEvent::onSettingValidationError(), function ($name, $message) {
        // Handle stormnodes:admin:settings:validation:error
        // Parameters: string setting name, string error message.
    });
}