Plugin
API reference › Scaffold › Plugin
Registers the EventSubscriber that scaffolds provider files after composer install, composer update and
composer create-project.
Methods
Section titled “Methods”| Method | Description | Defined by |
|---|---|---|
activate() | Creates the event subscriber and registers it with Composer’s event dispatcher. | Plugin |
deactivate() | Removes the registered event subscriber from Composer’s event dispatcher. | Plugin |
uninstall() | Performs no cleanup; scaffolded files and scaffold-lock.json stay in the project. | Plugin |
Method details
Section titled “Method details”activate()
Section titled “activate() ”public function activate(Composer\Composer $composer, Composer\IO\IOInterface $io): voidCreates the event subscriber and registers it with Composer’s event dispatcher.
Parameters
| Parameter | Type | Description |
|---|---|---|
$composer | Composer\ | Composer instance whose event dispatcher receives the subscriber. |
$io | Composer\ | Composer IO; unused. |
deactivate()
Section titled “deactivate() ”public function deactivate(Composer\Composer $composer, Composer\IO\IOInterface $io): voidRemoves the registered event subscriber from Composer’s event dispatcher.
Parameters
| Parameter | Type | Description |
|---|---|---|
$composer | Composer\ | Composer instance whose event dispatcher holds the subscriber. |
$io | Composer\ | Composer IO; unused. |
uninstall()
Section titled “uninstall() ”public function uninstall(Composer\Composer $composer, Composer\IO\IOInterface $io): voidPerforms no cleanup; scaffolded files and scaffold-lock.json stay in the project.
Parameters
| Parameter | Type | Description |
|---|---|---|
$composer | Composer\ | Composer instance; unused. |
$io | Composer\ | Composer IO; unused. |