Files
opensourcepos/app/Libraries/Plugins/PluginManager.php
Ollama a9669ddf19 feat(plugins): Implement modular plugin system with self-registering events
This implements a clean plugin architecture based on PR #4255 discussion:

Core Components:
- PluginInterface: Standard contract all plugins must implement
- BasePlugin: Abstract class with common functionality
- PluginManager: Discovers and loads plugins from app/Plugins/
- Plugin_config: Model for plugin settings storage

Architecture:
- Each plugin registers its own event listeners via registerEvents()
- No hardcoded plugin dependencies in core Events.php
- Generic event triggers (item_sale, item_change, etc.) remain in core code
- Plugins can be enabled/disabled via database settings
- Clean separation: plugin orchestrators vs MVC components

Example Implementations:
- ExamplePlugin: Simple plugin demonstrating event logging
- MailchimpPlugin: Integration with Mailchimp for customer sync

Admin UI:
- Plugin management controller at Controllers/Plugins/Manage.php
- Plugin management view at Views/plugins/manage.php

Database:
- ospos_plugin_config table for plugin settings (key-value store)
- Migration creates table with timestamps

Documentation:
- Comprehensive README with architecture patterns
- Simple vs complex plugin examples
- MVC directory structure guidance
2026-03-09 21:58:53 +01:00

207 lines
5.5 KiB
PHP

<?php
namespace App\Libraries\Plugins;
use App\Models\Plugin_config;
use CodeIgniter\Events\Events;
use DirectoryIterator;
/**
* Plugin Manager
*
* Discovers, loads, and manages plugins in the OSPOS system.
* Plugins are discovered from app/Plugins directory and must implement PluginInterface.
*/
class PluginManager
{
private array $plugins = [];
private array $enabledPlugins = [];
private Plugin_config $configModel;
private string $pluginsPath;
public function __construct()
{
$this->configModel = new Plugin_config();
$this->pluginsPath = APPPATH . 'Plugins';
}
/**
* Discover and load all available plugins.
*
* Scans the Plugins directory for classes implementing PluginInterface.
*/
public function discoverPlugins(): void
{
if (!is_dir($this->pluginsPath)) {
log_message('debug', 'Plugins directory does not exist: ' . $this->pluginsPath);
return;
}
$iterator = new DirectoryIterator($this->pluginsPath);
foreach ($iterator as $file) {
if ($file->isDir() || $file->getExtension() !== 'php') {
continue;
}
$className = 'App\\Plugins\\' . $file->getBasename('.php');
if (!class_exists($className)) {
continue;
}
$plugin = new $className();
if (!$plugin instanceof PluginInterface) {
log_message('warning', "Plugin {$className} does not implement PluginInterface");
continue;
}
$this->plugins[$plugin->getPluginId()] = $plugin;
log_message('debug', "Discovered plugin: {$plugin->getPluginName()}");
}
}
/**
* Register event listeners for all enabled plugins.
*
* This should be called during application bootstrap.
*/
public function registerPluginEvents(): void
{
foreach ($this->plugins as $pluginId => $plugin) {
if ($this->isPluginEnabled($pluginId)) {
$this->enabledPlugins[$pluginId] = $plugin;
$plugin->registerEvents();
log_message('debug', "Registered events for plugin: {$plugin->getPluginName()}");
}
}
}
/**
* Get all discovered plugins.
*
* @return array<string, PluginInterface>
*/
public function getAllPlugins(): array
{
return $this->plugins;
}
/**
* Get all enabled plugins.
*
* @return array<string, PluginInterface>
*/
public function getEnabledPlugins(): array
{
return $this->enabledPlugins;
}
/**
* Get a specific plugin by ID.
*/
public function getPlugin(string $pluginId): ?PluginInterface
{
return $this->plugins[$pluginId] ?? null;
}
/**
* Check if a plugin is enabled.
*/
public function isPluginEnabled(string $pluginId): bool
{
$enabled = $this->configModel->get($this->getEnabledKey($pluginId));
return $enabled === '1' || $enabled === 'true';
}
/**
* Enable a plugin.
*/
public function enablePlugin(string $pluginId): bool
{
$plugin = $this->getPlugin($pluginId);
if (!$plugin) {
log_message('error', "Plugin not found: {$pluginId}");
return false;
}
// Check if plugin needs installation
if (!$this->configModel->exists($this->getInstalledKey($pluginId))) {
if (!$plugin->install()) {
log_message('error', "Failed to install plugin: {$pluginId}");
return false;
}
$this->configModel->set($this->getInstalledKey($pluginId), '1');
}
$this->configModel->set($this->getEnabledKey($pluginId), '1');
log_message('info', "Plugin enabled: {$pluginId}");
return true;
}
/**
* Disable a plugin.
*/
public function disablePlugin(string $pluginId): bool
{
$this->configModel->set($this->getEnabledKey($pluginId), '0');
log_message('info', "Plugin disabled: {$pluginId}");
return true;
}
/**
* Uninstall a plugin completely.
*/
public function uninstallPlugin(string $pluginId): bool
{
$plugin = $this->getPlugin($pluginId);
if (!$plugin) {
log_message('error', "Plugin not found: {$pluginId}");
return false;
}
if (!$plugin->uninstall()) {
log_message('error', "Failed to uninstall plugin: {$pluginId}");
return false;
}
// Remove all plugin configuration
$this->configModel->deleteAllStartingWith($pluginId . '_');
return true;
}
/**
* Get plugin setting.
*/
public function getSetting(string $pluginId, string $key, mixed $default = null): mixed
{
return $this->configModel->get("{$pluginId}_{$key}") ?? $default;
}
/**
* Set plugin setting.
*/
public function setSetting(string $pluginId, string $key, mixed $value): bool
{
return $this->configModel->set("{$pluginId}_{$key}", $value);
}
/**
* Get the enabled config key for a plugin.
*/
private function getEnabledKey(string $pluginId): string
{
return "{$pluginId}_enabled";
}
/**
* Get the installed config key for a plugin.
*/
private function getInstalledKey(string $pluginId): string
{
return "{$pluginId}_installed";
}
}