View .md

LdapProvidersEvent events

3 FeatherPanel plugin events on LdapProvidersEvent (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.

Setup

Import LdapProvidersEvent 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\LdapProvidersEvent;

class MyPlugin implements AppPlugin
{
    public static function processEvents(PluginEvents $event): void
    {
        $event->on(LdapProvidersEvent::onLdapProviderCreated(), function ($userUuid, $provider): void {
            App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:ldap:provider:create ' . json_encode(['user_uuid' => $userUuid, 'provider' => $provider]));
        });
    }

    public static function pluginInstall(): void
    {
    }

    public static function pluginUninstall(): void
    {
    }
}

LdapProvidersEvent::onLdapProviderCreated()

Name: featherpanel:ldap:provider:createemitted at 1 siteCancel or modify: nodefinition

Docblock: string|null user uuid, array provider.

#Payload keyListener parameterType
1user_uuid$userUuidstring|nullfrom docblock
2provider$providerarrayfrom docblock
When it fires (1 site)
$event->on(LdapProvidersEvent::onLdapProviderCreated(), function ($userUuid, $provider): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:ldap:provider:create ' . json_encode(['user_uuid' => $userUuid, 'provider' => $provider]));
});

LdapProvidersEvent::onLdapProviderDeleted()

Name: featherpanel:ldap:provider:deleteemitted at 1 siteCancel or modify: nodefinition

Docblock: string|null user uuid, array provider.

#Payload keyListener parameterType
1user_uuid$userUuidstring|nullfrom docblock
2provider$providerarrayfrom docblock
When it fires (1 site)
$event->on(LdapProvidersEvent::onLdapProviderDeleted(), function ($userUuid, $provider): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:ldap:provider:delete ' . json_encode(['user_uuid' => $userUuid, 'provider' => $provider]));
});

LdapProvidersEvent::onLdapProviderUpdated()

Name: featherpanel:ldap:provider:updateemitted at 1 siteCancel or modify: nodefinition

Docblock: string|null user uuid, array provider, array changed fields.

#Payload keyListener parameterType
1user_uuid$userUuidstring|nullfrom docblock
2provider$providerarrayfrom docblock
3changed_fields$changedFieldsarray
When it fires (1 site)
$event->on(LdapProvidersEvent::onLdapProviderUpdated(), function ($userUuid, $provider, $changedFields): void {
    App::getInstance(true)->getLogger()->info('[myplugin] featherpanel:ldap:provider:update ' . json_encode(['user_uuid' => $userUuid, 'provider' => $provider, 'changed_fields' => $changedFields]));
});