https://github.com/whilesmartphp/laravel-plugin-engine
A flexible and powerful plugin system for Laravel applications.
https://github.com/whilesmartphp/laravel-plugin-engine
Last synced: 5 months ago
JSON representation
A flexible and powerful plugin system for Laravel applications.
- Host: GitHub
- URL: https://github.com/whilesmartphp/laravel-plugin-engine
- Owner: whilesmartphp
- License: mit
- Created: 2025-06-16T20:01:03.000Z (12 months ago)
- Default Branch: dev
- Last Pushed: 2025-10-02T19:58:41.000Z (8 months ago)
- Last Synced: 2025-10-02T20:14:52.800Z (8 months ago)
- Language: PHP
- Size: 73.2 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Laravel Plugin Engine
[](https://github.com/whilesmart/laravel-plugin-engine/actions/workflows/tests.yml)
[](LICENSE)
A flexible and powerful plugin system for Laravel applications.
## Features
- Plugin discovery and registration
- Enable/disable plugins
- Plugin dependencies
- Console commands for plugin management
- Event-driven architecture
- Easy to extend
## Installation
1. Install the package via Composer:
```bash
composer require whilesmart/laravel-plugin-engine
```
2. Publish the configuration file (optional):
```bash
php artisan vendor:publish --provider="WhileSmart\LaravelPluginEngine\Providers\PluginServiceProvider" --tag=config
```
## Configuration
Publish the configuration file:
```bash
php artisan vendor:publish --provider="WhileSmart\LaravelPluginEngine\Providers\PluginServiceProvider" --tag=config
```
Edit the `config/plugins.php` file to configure the plugin system:
```php
return [
'path' => base_path('plugins'), // Path where plugins are stored
'namespace' => 'Plugins', // Root namespace for plugins
];
```
## Usage
### Available Commands
- `plugin:list` - List all available plugins
- `plugin:info {id}` - Show information about a plugin
- `plugin:enable {id}` - Enable a plugin
- `plugin:disable {id}` - Disable a plugin
- `plugin:install {package}` - Install a plugin
- `plugin:discover` - Discover and register all available plugins
### Creating a Plugin
1. Create a new directory in the `plugins` directory (or your configured path)
2. Create a `plugin.json` file with the following structure:
```json
{
"id": "example-plugin",
"name": "Example Plugin",
"description": "A sample plugin",
"version": "1.0.0",
"namespace": "Plugins\\Example",
"provider": "Plugins\\Example\\ExampleServiceProvider",
"enabled": true,
"requires": {
"php": ">=8.1",
"laravel/framework": "^10.0"
}
}
```
3. Create a service provider for your plugin:
```php
loadRoutesFrom(__DIR__.'/routes/web.php');
$this->loadViewsFrom(__DIR__.'/resources/views', 'example');
$this->loadMigrationsFrom(__DIR__.'/database/migrations');
}
}
```
## Plugin Structure
```
plugins/
example-plugin/
src/
Http/
Controllers/
Models/
Providers/
ExampleServiceProvider.php
resources/
views/
routes/
web.php
database/
migrations/
plugin.json
README.md
```
## Events
The plugin system dispatches several events that you can listen for:
- `WhileSmart\PluginEngine\Events\PluginEnabling` - Fired before a plugin is enabled
- `WhileSmart\PluginEngine\Events\PluginEnabled` - Fired after a plugin is enabled
- `WhileSmart\PluginEngine\Events\PluginDisabling` - Fired before a plugin is disabled
- `WhileSmart\PluginEngine\Events\PluginDisabled` - Fired after a plugin is disabled
- `WhileSmart\PluginEngine\Events\PluginInstalled` - Fired after a plugin is installed
- `WhileSmart\PluginEngine\Events\PluginDiscovered` - Fired when a plugin is discovered
## License
This project is open-source and licensed under the [MIT License](./LICENSE).