Class yii\composer\Plugin
| Inheritance | yii\composer\Plugin |
|---|---|
| Implements | Composer\EventDispatcher\EventSubscriberInterface, Composer\Plugin\PluginInterface |
| Available since version | 2.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
| 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
| public void activate ( \Composer\Composer $composer, \Composer\IO\IOInterface $io ) | ||
| $composer | ||
| $io | ||
Listen to POST_PACKAGE_UPDATE event and take note of the package updates.
| public void checkPackageUpdates ( \Composer\Installer\PackageEvent $event ) | ||
| $event | \Composer\Installer\PackageEvent | |
| public void deactivate ( \Composer\Composer $composer, \Composer\IO\IOInterface $io ) | ||
| $composer | ||
| $io | ||
| public static array getSubscribedEvents ( ) | ||
| return | array | The event names to listen to. |
|---|---|---|
Listen to POST_UPDATE_CMD event to display information about upgrade notes if appropriate.
| public void showUpgradeNotes ( \Composer\Script\Event $event ) | ||
| $event | \Composer\Script\Event | |
| public void uninstall ( \Composer\Composer $composer, \Composer\IO\IOInterface $io ) | ||
| $composer | ||
| $io | ||