API Reference Documentation

This document provides detailed information about all API interfaces, command-line tools, and core libraries of the MineAdmin plugin system.

Command Line API

Plugin Management Commands

1. mine-extension:initial

Initialize the plugin extension system.

bash

php bin/hyperf.php mine-extension:initial

Features:

Publish app-store configuration files
Initialize plugin system configuration
Create necessary directory structure

Implementation Class: Mine\AppStore\Command\InitialCommand (GitHub)

2. mine-extension:list

Query remote plugin list.

bash

php bin/hyperf.php mine-extension:list [options]

Parameters:

Parameter	Type	Default	Description
--type	string	all	Filter extension type (mixed/backend/frontend)
--name	string	-	Filter by extension name
--category	string	-	Filter by category
--author	string	-	Filter by author

Examples:

bash

# View all plugins
php bin/hyperf.php mine-extension:list

# View mixed-type plugins
php bin/hyperf.php mine-extension:list --type=mixed

# Search for specific plugin
php bin/hyperf.php mine-extension:list --name=user-manager

Implementation Class: Mine\AppStore\Command\ListCommand (GitHub)

3. mine-extension:local-list

Query all local plugins.

bash

php bin/hyperf.php mine-extension:local-list [options]

Parameters:

Parameter	Type	Default	Description
--status	string	all	Filter by status (installed/enabled/disabled)
--type	string	all	Filter by type

Implementation Class: Mine\AppStore\Command\LocalListCommand (GitHub)

4. mine-extension:download

Download remote plugin to local.

bash

php bin/hyperf.php mine-extension:download --name=plugin-name [options]

Parameters:

Parameter	Type	Required	Description
--name	string	Yes	Plugin name
--version	string	No	Specify version
--force	bool	No	Force overwrite existing plugin

Implementation Class: Mine\AppStore\Command\DownloadCommand (GitHub)

5. mine-extension:install

Install specified plugin.

bash

php bin/hyperf.php mine-extension:install {path} [options]

Parameters:

Parameter	Type	Required	Description
path	string	Yes	Plugin path (vendor/plugin-name)
--yes	bool	No	Skip confirmation prompt
--force	bool	No	Force reinstall
--skip-dependencies	bool	No	Skip dependency check

Examples:

bash

# Install plugin
php bin/hyperf.php mine-extension:install mineadmin/user-manager --yes

# Force reinstall
php bin/hyperf.php mine-extension:install mineadmin/user-manager --force

Implementation Class: Mine\AppStore\Command\InstallCommand (GitHub)

6. mine-extension:uninstall

Uninstall specified plugin.

bash

php bin/hyperf.php mine-extension:uninstall {path} [options]

Parameters:

Parameter	Type	Required	Description
path	string	Yes	Plugin path
--yes	bool	No	Skip confirmation prompt
--force	bool	No	Force uninstall (ignore errors)
--keep-data	bool	No	Preserve user data

Implementation Class: Mine\AppStore\Command\UninstallCommand (GitHub)

7. mine-extension:create

Create new plugin.

bash

php bin/hyperf.php mine-extension:create {path} [options]

Parameters:

Parameter	Type	Default	Description
path	string	-	Plugin path (vendor/plugin-name)
--name	string	example	Plugin display name
--type	string	mixed	Plugin type (mixed/backend/frontend)
--author	string	-	Author name
--description	string	-	Plugin description
--license	string	MIT	License type

Example:

bash

php bin/hyperf.php mine-extension:create mycompany/hello-world \
    --name "Hello World" \
    --type mixed \
    --author "Your Name" \
    --description "My first plugin"

Implementation Class: Mine\AppStore\Command\CreateCommand (GitHub)

Core Library API

Plugin Class

File Location: Mine\AppStore\Plugin (GitHub)

Core class of the plugin system, responsible for plugin loading and management.

Plugin::init()

Initialize the plugin system, called when the application starts.

php

<?php

use Mine\AppStore\Plugin;

// Initialize plugin system
Plugin::init();

Features:

Scan plugin/ directory
Load installed plugins
Register ConfigProvider
Autoload plugin classes

Plugin::getInstalled()

Get list of installed plugins.

php

<?php

use Mine\AppStore\Plugin;

// Get all installed plugins
$plugins = Plugin::getInstalled();

// Return format
[
    'vendor/plugin-name' => [
        'name' => 'vendor/plugin-name',
        'version' => '1.0.0',
        'path' => '/path/to/plugin',
        'config' => [...], // mine.json configuration
        'status' => 'enabled'
    ]
]

Plugin::isInstalled()

Check if plugin is installed.

php

<?php

use Mine\AppStore\Plugin;

// Check if plugin is installed
if (Plugin::isInstalled('vendor/plugin-name')) {
    // Plugin is installed
}

Plugin::getConfig()

Get plugin configuration.

php

<?php

use Mine\AppStore\Plugin;

// Get plugin configuration
$config = Plugin::getConfig('vendor/plugin-name');

// Returns parsed array from mine.json

ExtensionManager Class

File Location: app/Service/ExtensionManager.php

Responsible for plugin installation, uninstallation, and update operations.

install()

Install plugin.

php

<?php

use App\Service\ExtensionManager;

$manager = new ExtensionManager();

// Install plugin
$result = $manager->install('vendor/plugin-name', [
    'force' => false,
    'skip_dependencies' => false
]);

if ($result['success']) {
    echo "Installation successful";
} else {
    echo "Installation failed: " . $result['message'];
}

uninstall()

Uninstall plugin.

php

<?php

use App\Service\ExtensionManager;

$manager = new ExtensionManager();

// Uninstall plugin
$result = $manager->uninstall('vendor/plugin-name', [
    'force' => false,
    'keep_data' => false
]);

update()

Update plugin.

php

<?php

use App\Service\ExtensionManager;

$manager = new ExtensionManager();

// Update plugin
$result = $manager->update('vendor/plugin-name');

ConfigProvider Base Class

All plugin ConfigProviders should follow this interface:

php

<?php

namespace Plugin\Vendor\PluginName;

class ConfigProvider
{
    public function __invoke(): array
    {
        return [
            // Dependency injection configuration
            'dependencies' => [
                InterfaceA::class => ImplementationA::class,
            ],
            
            // Annotation scan paths
            'annotations' => [
                'scan' => [
                    'paths' => [
                        __DIR__,
                    ],
                ],
            ],
            
            // Command line commands
            'commands' => [
                CustomCommand::class,
            ],
            
            // Event listeners
            'listeners' => [
                CustomListener::class,
            ],
            
            // Middleware
            'middlewares' => [
                'http' => [
                    CustomMiddleware::class,
                ],
            ],
            
            // Configuration file publishing
            'publish' => [
                [
                    'id' => 'config-id',
                    'description' => 'Configuration file description',
                    'source' => __DIR__ . '/../publish/config.php',
                    'destination' => BASE_PATH . '/config/autoload/plugin.php',
                ],
            ],
            
            // Process configuration
            'processes' => [
                CustomProcess::class,
            ],
        ];
    }
}

HTTP API

Plugin Management Interface

Get Plugin List

http

GET /admin/plugin/list

Request Parameters:

json

{
  "page": 1,
  "pageSize": 15,
  "type": "mixed",
  "status": "enabled",
  "keyword": "search term"
}

Response Example:

json

{
  "code": 200,
  "message": "success",
  "data": {
    "list": [
      {
        "name": "vendor/plugin-name",
        "display_name": "Plugin Display Name",
        "version": "1.0.0",
        "description": "Plugin description",
        "author": "Author name",
        "type": "mixed",
        "status": "enabled",
        "installed_at": "2024-01-01 12:00:00",
        "updated_at": "2024-01-15 10:30:00"
      }
    ],
    "total": 1
  }
}

Install Plugin

http

POST /admin/plugin/install

Request Parameters:

json

{
  "name": "vendor/plugin-name",
  "version": "1.0.0",
  "force": false
}

Response Example:

json

{
  "code": 200,
  "message": "Installation successful",
  "data": {
    "plugin": "vendor/plugin-name",
    "version": "1.0.0",
    "installed_at": "2024-01-01 12:00:00"
  }
}

Uninstall Plugin

http

DELETE /admin/plugin/uninstall

Request Parameters:

json

{
  "name": "vendor/plugin-name",
  "keep_data": false
}

Enable/Disable Plugin

http

PUT /admin/plugin/toggle-status

Request Parameters:

json

{
  "name": "vendor/plugin-name",
  "status": "enabled"  // enabled | disabled
}

Event API

Plugin Event System

The plugin system provides rich event hooks, allowing developers to execute custom logic at key points in the plugin lifecycle.

Event Types

php

<?php

namespace App\Event\Plugin;

// Before plugin installation event
class BeforeInstallEvent
{
    public function __construct(
        public string $pluginName,
        public array $config,
        public array $options = []
    ) {}
}

// After plugin installation event
class AfterInstallEvent
{
    public function __construct(
        public string $pluginName,
        public string $version,
        public bool $success,
        public ?string $error = null
    ) {}
}

// Before plugin uninstallation event
class BeforeUninstallEvent
{
    public function __construct(
        public string $pluginName,
        public array $options = []
    ) {}
}

// After plugin uninstallation event
class AfterUninstallEvent
{
    public function __construct(
        public string $pluginName,
        public bool $success,
        public ?string $error = null
    ) {}
}

Event Listener Example

php

<?php

namespace App\Listener\Plugin;

use Hyperf\Event\Annotation\Listener;
use Hyperf\Event\Contract\ListenerInterface;
use App\Event\Plugin\AfterInstallEvent;

#[Listener]
class PluginInstallListener implements ListenerInterface
{
    public function listen(): array
    {
        return [
            AfterInstallEvent::class,
        ];
    }

    public function process(object $event): void
    {
        if ($event->success) {
            // Post-installation processing
            $this->clearCache();
            $this->sendNotification($event->pluginName);
            $this->updateStatistics($event->pluginName);
        } else {
            // Installation failure handling
            logger()->error('Plugin installation failed', [
                'plugin' => $event->pluginName,
                'error' => $event->error
            ]);
        }
    }
}

Hook API

Plugin Hook System

MineAdmin provides a hook system that allows plugins to inject custom logic at key system points.

Register Hook

php

<?php

use App\Hook\HookManager;

// Register hooks in ConfigProvider
class ConfigProvider
{
    public function __invoke(): array
    {
        // Register hooks
        HookManager::register('user.login.before', function($user) {
            // Pre-login processing logic
            logger()->info('User attempting login', ['user_id' => $user->id]);
        });
        
        HookManager::register('user.login.after', function($user) {
            // Post-login processing logic
            $this->recordLoginHistory($user);
        });
        
        return [
            // ... other configurations
        ];
    }
}

Trigger Hook

php

<?php

use App\Hook\HookManager;

// Trigger hooks in system code
class UserService
{
    public function login(array $credentials): bool
    {
        // Pre-login hook
        HookManager::trigger('user.login.before', $user);
        
        // Execute login logic
        $result = $this->authenticate($credentials);
        
        if ($result) {
            // Post-login hook
            HookManager::trigger('user.login.after', $user);
        }
        
        return $result;
    }
}

Available Hooks List

Hook Name	Trigger Point	Parameters
`user.login.before`	Before user login	User $user
`user.login.after`	After user login	User $user
`user.logout.before`	Before user logout	User $user
`user.logout.after`	After user logout	User $user
`menu.render.before`	Before menu rendering	array $menus
`menu.render.after`	After menu rendering	array $menus
`permission.check.before`	Before permission check	string $permission, User $user
`permission.check.after`	After permission check	bool $result, string $permission, User $user

Utility Class API

PluginHelper Class

Provides common utility methods for plugin development.

php

<?php

namespace App\Helper;

class PluginHelper
{
    /**
     * Get plugin root path
     */
    public static function getPluginPath(string $pluginName): string
    {
        return BASE_PATH . '/plugin/' . str_replace('/', DIRECTORY_SEPARATOR, $pluginName);
    }
    
    /**
     * Get plugin configuration
     */
    public static function getPluginConfig(string $pluginName): ?array
    {
        $configPath = self::getPluginPath($pluginName) . '/mine.json';
        
        if (!file_exists($configPath)) {
            return null;
        }
        
        return json_decode(file_get_contents($configPath), true);
    }
    
    /**
     * Check if plugin is installed
     */
    public static function isInstalled(string $pluginName): bool
    {
        $lockFile = self::getPluginPath($pluginName) . '/install.lock';
        return file_exists($lockFile);
    }
    
    /**
     * Get plugin version
     */
    public static function getVersion(string $pluginName): ?string
    {
        $config = self::getPluginConfig($pluginName);
        return $config['version'] ?? null;
    }
    
    /**
     * Get plugin asset URL
     */
    public static function getAssetUrl(string $pluginName, string $asset): string
    {
        return "/plugin/{$pluginName}/assets/{$asset}";
    }
}

Usage Example

php

<?php

use App\Helper\PluginHelper;

// Get plugin path
$path = PluginHelper::getPluginPath('vendor/plugin-name');

// Check if plugin is installed
if (PluginHelper::isInstalled('vendor/plugin-name')) {
    // Get plugin version
    $version = PluginHelper::getVersion('vendor/plugin-name');
    
    // Get asset URL
    $cssUrl = PluginHelper::getAssetUrl('vendor/plugin-name', 'style.css');
}

Error Code Reference

Plugin Installation Error Codes

Error Code	Description	Solution
10001	Plugin directory not found	Check plugin path
10002	mine.json file not found	Ensure plugin contains configuration file
10003	mine.json format error	Check JSON syntax
10004	Dependency plugin not installed	Install dependency first
10005	Version conflict	Resolve version compatibility issues
10006	Database migration failed	Check database connection and permissions
10007	File copy failed	Check file permissions
10008	Installation script execution failed	Check installation script error logs

Plugin Uninstallation Error Codes

Error Code	Description	Solution
20001	Plugin not installed	No need to uninstall
20002	Dependent plugins exist	Uninstall dependencies first or use force uninstall
20003	Uninstallation script execution failed	Check uninstallation script error logs

API Reference Documentation ​

Command Line API ​

Plugin Management Commands ​

1. mine-extension:initial ​

2. mine-extension:list ​

3. mine-extension:local-list ​

4. mine-extension:download ​

5. mine-extension:install ​

6. mine-extension:uninstall ​

7. mine-extension:create ​

Core Library API ​

Plugin Class ​

Plugin::init() ​

Plugin::getInstalled() ​

Plugin::isInstalled() ​

Plugin::getConfig() ​

ExtensionManager Class ​

install() ​

uninstall() ​

update() ​

ConfigProvider Base Class ​

HTTP API ​

Plugin Management Interface ​

Get Plugin List ​

Install Plugin ​

Uninstall Plugin ​

Enable/Disable Plugin ​

Event API ​

Plugin Event System ​

Event Types ​

Event Listener Example ​

Hook API ​

Plugin Hook System ​

Register Hook ​

Trigger Hook ​

Available Hooks List ​

Utility Class API ​

PluginHelper Class ​

Usage Example ​

Error Code Reference ​

Plugin Installation Error Codes ​

Plugin Uninstallation Error Codes ​

API Reference Documentation

Command Line API

Plugin Management Commands

1. mine-extension:initial

2. mine-extension:list

3. mine-extension:local-list

4. mine-extension:download

5. mine-extension:install

6. mine-extension:uninstall

7. mine-extension:create

Core Library API

Plugin Class

Plugin::init()

Plugin::getInstalled()

Plugin::isInstalled()

Plugin::getConfig()

ExtensionManager Class

install()

uninstall()

update()

ConfigProvider Base Class

HTTP API

Plugin Management Interface

Get Plugin List

Install Plugin

Uninstall Plugin

Enable/Disable Plugin

Event API

Plugin Event System

Event Types

Event Listener Example

Hook API

Plugin Hook System

Register Hook

Trigger Hook

Available Hooks List

Utility Class API

PluginHelper Class

Usage Example

Error Code Reference

Plugin Installation Error Codes

Plugin Uninstallation Error Codes