如何为自己的项目编写composer插件

composer.json

ComposerPluginPluginInterface

ComposerEventDispatcherEventSubscriberInterface

<?php

namespace MyProjectComposerPlugin;

use ComposerComposer;
use ComposerIOIOInterface;
use ComposerPluginPluginInterface;
use ComposerEventDispatcherEventSubscriberInterface;
use ComposerScriptEvent; // 或者其他你需要的事件类

class MyProjectPlugin implements PluginInterface, EventSubscriberInterface
{
    protected $composer;
    protected $io;

    /**
     * Activate the plugin.
     * This method is called when the plugin is loaded.
     */
    public function activate(Composer $composer, IOInterface $io)
    {
        $this->composer = $composer;
        $this->io = $io;
        $this->io->write('<info>MyProject Composer Plugin activated!</info>');
    }

    /**
     * Deactivate the plugin.
     * This method is called when the plugin is unloaded.
     */
    public function deactivate(Composer $composer, IOInterface $io)
    {
        $this->io->write('<info>MyProject Composer Plugin deactivated!</info>');
    }

    /**
     * Uninstall the plugin.
     * This method is called when the plugin is uninstalled.
     */
    public function uninstall(Composer $composer, IOInterface $io)
    {
        $this->io->write('<info>MyProject Composer Plugin uninstalled!</info>');
    }

    /**
     * Returns an array of event names this subscriber wants to listen to.
     * The array keys are event names, and the value can be:
     *  - The method name to call (e.g., 'onPostInstallCmd')
     *  - An array composed of the method name and priority (e.g., ['onPostInstallCmd', 0])
     */
    public static function getSubscribedEvents()
    {
        return [
            'post-install-cmd' => 'onPostInstallCmd',
            'post-update-cmd' => 'onPostUpdateCmd',
            // 可以订阅更多事件，例如 'pre-package-install', 'post-package-install' 等
        ];
    }

    /**
     * Handles the post-install-cmd event.
     */
    public function onPostInstallCmd(Event $event)
    {
        $this->io->write('<info>Executing custom logic after install command...</info>');
        // 在这里编写你的自定义逻辑，例如文件复制、权限设置等
        $this->copyCustomConfig();
    }

    /**
     * Handles the post-update-cmd event.
     */
    public function onPostUpdateCmd(Event $event)
    {
        $this->io->write('<info>Executing custom logic after update command...</info>');
        // 在这里编写你的自定义逻辑
        $this->generateServiceFiles();
    }

    protected function copyCustomConfig()
    {
        $this->io->write('  - Copying custom config file...');
        // 假设你要从插件目录复制一个文件到项目根目录
        $vendorDir = $this->composer->getConfig()->get('vendor-dir');
        $projectRoot = dirname($vendorDir);
        $sourcePath = realpath(__DIR__ . '/../../config/my_config.php'); // 假设插件在 vendor/my-vendor/my-plugin/src 下
        $destinationPath = $projectRoot . '/config/my_project_config.php';

        if (file_exists($sourcePath)) {
            if (!is_dir(dirname($destinationPath))) {
                mkdir(dirname($destinationPath), 0755, true);
            }
            copy($sourcePath, $destinationPath);
            $this->io->write('    <info>Copied ' . basename($sourcePath) . ' to ' . $destinationPath . '</info>');
        } else {
            $this->io->write('<warning>Source config file not found: ' . $sourcePath . '</warning>');
        }
    }

    protected function generateServiceFiles()
    {
        $this->io->write('  - Generating service definitions...');
        // 模拟生成一些文件
        $vendorDir = $this->composer->getConfig()->get('vendor-dir');
        $projectRoot = dirname($vendorDir);
        $outputPath = $projectRoot . '/var/cache/services.php';
        if (!is_dir(dirname($outputPath))) {
            mkdir(dirname($outputPath), 0755, true);
        }
        file_put_contents($outputPath, "<?php
// Generated by MyProject Composer Plugin
return ['service_a' => new stdClass()];
");
        $this->io->write('    <info>Generated ' . $outputPath . '</info>');
    }
}

composer.json

extra

{
    "name": "my-vendor/my-project",
    "description": "My awesome project.",
    "type": "project",
    "require": {
        "php": ">=7.4"
    },
    "autoload": {
        "psr-4": {
            "MyProject\": "src/"
        }
    },
    "extra": {
        "class": "MyProject\ComposerPlugin\MyProjectPlugin"
    },
    "config": {
        "allow-plugins": {
            "my-vendor/my-project": true, // 允许你的项目作为插件被加载
            "my-vendor/my-plugin": true // 如果你的插件是单独的包，需要允许它
        }
    }
}

src/

"my-vendor/my-project": true

my-vendor/my-plugin

require

allow-plugins

"my-vendor/my-plugin": true

composer install

composer update

onPostInstallCmd

onPostUpdateCmd

post-install-cmd

post-update-cmd

scripts

$this->io->write()

getSubscribedEvents()

public static function getSubscribedEvents()
{
    return [
        'post-install-cmd' => 'onPostInstallCmd',
        'pre-package-install' => ['onPrePackageInstall', 10], // 优先级可以调整，数字越大越早执行
        'post-package-update' => 'onPostPackageUpdate',
        'pre-autoload-dump' => 'onPreAutoloadDump'
    ];
}

post-install-cmd

post-update-cmd

pre-package-*

post-package-*