bethropolis / plugin-system
A lightweight plugin system & manager for your PHP project
Requires
- php: ^8.0
Requires (Dev)
- phpunit/phpunit: ^10.2
This package is auto-updated.
Last update: 2024-06-06 01:52:43 UTC
README
This is a lightweight, flexible, hook and event based plugin manager and system.
It allows you to easily integrate plugins feature into your PHP applications, providing a modular and extensible architecture.
Features
- Easy integration
- Dynamic loading
- Hook-based architecture
- Event-driven programming
- Flexible and extensible
- plugin manager included
- plugin life cycle
Installation
you will require composer to install. Run the following command in your project directory:
composer require bethropolis/plugin-system
you can also download the latest release and add it to your project directory.
note that if you do this you will have to require the autoloader file into your project scripts. example
require "plugin-system/src/autoload.php";
Usage
Loading Plugins
To load plugins from a specific directory, use the loadPlugins
method:
require "vendor/autoload.php"; // for download installed method just replace this line with the autoloader. use Bethropolis\PluginSystem\System; $dir = __DIR__ . "/examples/"; # directory to load plugins from System::loadPlugins($dir);
Linking Plugins to Hooks
Plugins functions can be linked to hooks using the linkPluginToHook
method. This allows you to define actions that will be executed when a particular hook is triggered:
use Bethropolis\PluginSystem\System; // Link a plugin function to a hook System::linkPluginToHook('my_hook', $callback);
Triggering Hooks and Events
Hooks can be triggered using the executeHook()
method, and events can be triggered using the triggerEvent()
method. Here's an example:
use Bethropolis\PluginSystem\System; // Trigger a hook System::executeHook('my_hook', $pluginName, ...$args); // trigger multiple hooks System::executeHooks(['my_hook1', 'my_hook2'], $pluginName, ...$args); # Events // Register an event System::registerEvent('my_event'); // Add an action to the event System::addAction('my_event', function ($arg) { // Action code here }); // Trigger the event System::triggerEvent('my_event', ...$args);
plugin
here is an example of a plugin:
// eg. FILE: /plugins-folder/examplepugin.php class ExamplePlugin extends \Bethropolis\PluginSystem\Plugin { public function initialize() { $this->linkHook('my_hook', array($this, 'myCallback')); } public function myCallback($name = []) { $name = array_shift($name); return "hello {$name}"; } }
more Examples
The examples directory contains sample plugins that demonstrate the usage of the Plugin System.
Contributing
Contributions to the project are welcome! If you encounter any issues, have suggestions for improvements, or would like to add new features, please feel free to open an issue or submit a pull request.
About
this project was made to be a plugin management system for another one of my project but I hope it can help someone else out there.
License
this project is released under the MIT License. You can find more details in the LICENSE file.