Class yii\composer\Plugin

Inheritanceyii\composer\Plugin
ImplementsComposer\EventDispatcher\EventSubscriberInterface, Composer\Plugin\PluginInterface
Available since version2.0
Source Code https://github.com/yiisoft/yii2-composer/blob/master/Plugin.php

Plugin is the composer plugin that registers the Yii composer installer.

Public Methods

Hide inherited methods

Method Description Defined By
activate() yii\composer\Plugin
checkPackageUpdates() Listen to POST_PACKAGE_UPDATE event and take note of the package updates. yii\composer\Plugin
deactivate() yii\composer\Plugin
getSubscribedEvents() yii\composer\Plugin
showUpgradeNotes() Listen to POST_UPDATE_CMD event to display information about upgrade notes if appropriate. yii\composer\Plugin
uninstall() yii\composer\Plugin

Method Details

Hide inherited methods

activate() public method
public activate( \Composer\Composer $composer, \Composer\IO\IOInterface $io ):
$composer \Composer\Composer
$io \Composer\IO\IOInterface

                public function activate(Composer $composer, IOInterface $io)
{
    $this->_installer = new Installer($io, $composer);
    $composer->getInstallationManager()->addInstaller($this->_installer);
    $this->_vendorDir = rtrim($composer->getConfig()->get('vendor-dir'), '/');
    $file = $this->_vendorDir . '/yiisoft/extensions.php';
    if (!is_file($file)) {
        @mkdir(dirname($file), 0777, true);
        file_put_contents($file, "<?php\n\nreturn [];\n");
    }
}

            
checkPackageUpdates() public method

Listen to POST_PACKAGE_UPDATE event and take note of the package updates.

public checkPackageUpdates( \Composer\Installer\PackageEvent $event ): mixed
$event \Composer\Installer\PackageEvent

                public function checkPackageUpdates(PackageEvent $event)
{
    $operation = $event->getOperation();
    if ($operation instanceof UpdateOperation) {
        $this->_packageUpdates[$operation->getInitialPackage()->getName()] = [
            'from' => $operation->getInitialPackage()->getVersion(),
            'fromPretty' => $operation->getInitialPackage()->getPrettyVersion(),
            'to' => $operation->getTargetPackage()->getVersion(),
            'toPretty' => $operation->getTargetPackage()->getPrettyVersion(),
            'direction' => $this->_isUpgrade($event, $operation) ? 'up' : 'down',
        ];
    }
}

            
deactivate() public method
public deactivate( \Composer\Composer $composer, \Composer\IO\IOInterface $io ):
$composer \Composer\Composer
$io \Composer\IO\IOInterface

                public function deactivate(Composer $composer, IOInterface $io)
{
    $composer->getInstallationManager()->removeInstaller($this->_installer);
}

            
getSubscribedEvents() public static method
public static getSubscribedEvents( ): array
return array

The event names to listen to.

                public static function getSubscribedEvents()
{
    return [
        PackageEvents::POST_PACKAGE_UPDATE => 'checkPackageUpdates',
        ScriptEvents::POST_UPDATE_CMD => 'showUpgradeNotes',
    ];
}

            
showUpgradeNotes() public method

Listen to POST_UPDATE_CMD event to display information about upgrade notes if appropriate.

public showUpgradeNotes( \Composer\Script\Event $event ): mixed
$event \Composer\Script\Event

                public function showUpgradeNotes(Script\Event $event)
{
    $packageName = 'yiisoft/yii2';
    if (!isset($this->_packageUpdates[$packageName])) {
        return;
    }
    $package = $this->_packageUpdates['yiisoft/yii2'];
    // do not show a notice on up/downgrades between dev versions
    // avoid messages like from version dev-master to dev-master
    if ($package['fromPretty'] == $package['toPretty']) {
        return;
    }
    $io = $event->getIO();
    // print the relevant upgrade notes for the upgrade
    // - only on upgrade, not on downgrade
    // - only if the "from" version is non-dev, otherwise we have no idea which notes to show
    if ($package['direction'] === 'up' && $this->isNumericVersion($package['fromPretty'])) {
        $notes = $this->findUpgradeNotes($packageName, $package['fromPretty']);
        if ($notes !== false && empty($notes)) {
            // no relevent upgrade notes, do not show anything.
            return;
        }
        $this->printUpgradeIntro($io, $package);
        if ($notes) {
            // safety check: do not display notes if they are too many
            if (count($notes) > 250) {
                $io->write("\n  <fg=yellow;options=bold>The relevant notes for your upgrade are too long to be displayed here.</>");
            } else {
                $io->write("\n  " . trim(implode("\n  ", $notes)));
            }
        }
        $io->write("\n  You can find the upgrade notes for all versions online at:");
    } else {
        $this->printUpgradeIntro($io, $package);
        $io->write("\n  You can find the upgrade notes online at:");
    }
    $this->printUpgradeLink($io, $package);
}

            
uninstall() public method
public uninstall( \Composer\Composer $composer, \Composer\IO\IOInterface $io ):
$composer \Composer\Composer
$io \Composer\IO\IOInterface

                public function uninstall(Composer $composer, IOInterface $io)
{
}