# Plugin

> Registers the PHPForge\Scaffold\EventSubscriber that scaffolds provider files after composer install, composer update and composer create-project.

[API reference](/docs/api/index.md) › [Scaffold](/docs/extensions/scaffold/reference/index.md) › Plugin

| final class | `PHPForge\Scaffold\Plugin` |
| --- | --- |
| Implements | `Composer\Plugin\PluginInterface` |
| Source | [`src/Plugin.php`](https://github.com/php-forge/scaffold/blob/main/src/Plugin.php#L15) |

Registers the [`EventSubscriber`](/docs/extensions/scaffold/reference/eventsubscriber/index.md) that scaffolds provider files after `composer install`, `composer update` and
`composer create-project`.

## Methods

| Method | Description | Defined by |
| --- | --- | --- |
| [`activate()`](#method-activate) | Creates the event subscriber and registers it with Composer's event dispatcher. | `Plugin` |
| [`deactivate()`](#method-deactivate) | Removes the registered event subscriber from Composer's event dispatcher. | `Plugin` |
| [`uninstall()`](#method-uninstall) | Performs no cleanup; scaffolded files and `scaffold-lock.json` stay in the project. | `Plugin` |

## Method details

### activate() <span id="method-activate"></span>

```php
public function activate(Composer\Composer $composer, Composer\IO\IOInterface $io): void
```

Creates the event subscriber and registers it with Composer's event dispatcher.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$composer` | `Composer\Composer` | Composer instance whose event dispatcher receives the subscriber. |
| `$io` | `Composer\IO\IOInterface` | Composer IO; unused. |

### deactivate() <span id="method-deactivate"></span>

```php
public function deactivate(Composer\Composer $composer, Composer\IO\IOInterface $io): void
```

Removes the registered event subscriber from Composer's event dispatcher.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$composer` | `Composer\Composer` | Composer instance whose event dispatcher holds the subscriber. |
| `$io` | `Composer\IO\IOInterface` | Composer IO; unused. |

### uninstall() <span id="method-uninstall"></span>

```php
public function uninstall(Composer\Composer $composer, Composer\IO\IOInterface $io): void
```

Performs no cleanup; scaffolded files and `scaffold-lock.json` stay in the project.

**Parameters**

| Parameter | Type | Description |
| --- | --- | --- |
| `$composer` | `Composer\Composer` | Composer instance; unused. |
| `$io` | `Composer\IO\IOInterface` | Composer IO; unused. |