public-mirrors
/
composer
mirror of https://github.com/composer/composer
1
0
Fork 0
Code

Update script/plugin docs

pull/3818/head
Jordi Boggiano 2015-03-04 23:50:10 +00:00
parent 3b018e4276
commit 26799f4244
2 changed files with 44 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
doc/articles/plugins.md
View File

@ -82,15 +82,7 @@ Furthermore plugins may implement the
event handlers automatically registered with the `EventDispatcher` when the event handlers automatically registered with the `EventDispatcher` when the
plugin is loaded. plugin is loaded.
The events available for plugins are: Plugin can subscribe to any of the available [script events](scripts.md#event-names).
* **COMMAND**, is called at the beginning of all commands that load plugins.
It provides you with access to the input and output objects of the program.
* **PRE_FILE_DOWNLOAD**, is triggered before files are downloaded and allows
you to manipulate the `RemoteFilesystem` object prior to downloading files
based on the URL to be downloaded.
> A plugin can also subscribe to [script events][7].
Example: Example:
@ -148,7 +140,7 @@ list of installed packages. Additionally all plugin packages installed in the
local project plugins are loaded. local project plugins are loaded.
> You may pass the `--no-plugins` option to composer commands to disable all > You may pass the `--no-plugins` option to composer commands to disable all
> installed commands. This may be particularly helpful if any of the plugins > installed plugins. This may be particularly helpful if any of the plugins
> causes errors and you wish to update or uninstall it. > causes errors and you wish to update or uninstall it.
[1]: ../04-schema.md#type [1]: ../04-schema.md#type
@ -157,4 +149,3 @@ local project plugins are loaded.
[4]: https://github.com/composer/composer/blob/master/src/Composer/Composer.php [4]: https://github.com/composer/composer/blob/master/src/Composer/Composer.php
[5]: https://github.com/composer/composer/blob/master/src/Composer/IO/IOInterface.php [5]: https://github.com/composer/composer/blob/master/src/Composer/IO/IOInterface.php
[6]: https://github.com/composer/composer/blob/master/src/Composer/EventDispatcher/EventSubscriberInterface.php [6]: https://github.com/composer/composer/blob/master/src/Composer/EventDispatcher/EventSubscriberInterface.php
[7]: ./scripts.md#event-names

60
doc/articles/scripts.md
View File

@ -20,20 +20,16 @@ the Composer execution process.
Composer fires the following named events during its execution process: Composer fires the following named events during its execution process:
### Command Events
- **pre-install-cmd**: occurs before the `install` command is executed. - **pre-install-cmd**: occurs before the `install` command is executed.
- **post-install-cmd**: occurs after the `install` command is executed. - **post-install-cmd**: occurs after the `install` command is executed.
- **pre-update-cmd**: occurs before the `update` command is executed. - **pre-update-cmd**: occurs before the `update` command is executed.
- **post-update-cmd**: occurs after the `update` command is executed. - **post-update-cmd**: occurs after the `update` command is executed.
- **pre-status-cmd**: occurs before the `status` command is executed. - **pre-status-cmd**: occurs before the `status` command is executed.
- **post-status-cmd**: occurs after the `status` command is executed. - **post-status-cmd**: occurs after the `status` command is executed.
- **pre-dependencies-solving**: occurs before the dependencies are resolved. - **pre-archive-cmd**: occurs before the `archive` command is executed.
- **post-dependencies-solving**: occurs after the dependencies are resolved. - **post-archive-cmd**: occurs after the `archive` command is executed.
- **pre-package-install**: occurs before a package is installed.
- **post-package-install**: occurs after a package is installed.
- **pre-package-update**: occurs before a package is updated.
- **post-package-update**: occurs after a package is updated.
- **pre-package-uninstall**: occurs before a package has been uninstalled.
- **post-package-uninstall**: occurs after a package has been uninstalled.
- **pre-autoload-dump**: occurs before the autoloader is dumped, either - **pre-autoload-dump**: occurs before the autoloader is dumped, either
during `install`/`update`, or via the `dump-autoload` command. during `install`/`update`, or via the `dump-autoload` command.
- **post-autoload-dump**: occurs after the autoloader is dumped, either - **post-autoload-dump**: occurs after the autoloader is dumped, either
@ -42,8 +38,28 @@ Composer fires the following named events during its execution process:
installed, during the `create-project` command. installed, during the `create-project` command.
- **post-create-project-cmd**: occurs after the `create-project` command is - **post-create-project-cmd**: occurs after the `create-project` command is
executed. executed.
- **pre-archive-cmd**: occurs before the `archive` command is executed.
- **post-archive-cmd**: occurs after the `archive` command is executed. ### Installer Events
- **pre-dependencies-solving**: occurs before the dependencies are resolved.
- **post-dependencies-solving**: occurs after the dependencies are resolved.
### Package Events
- **pre-package-install**: occurs before a package is installed.
- **post-package-install**: occurs after a package is installed.
- **pre-package-update**: occurs before a package is updated.
- **post-package-update**: occurs after a package is updated.
- **pre-package-uninstall**: occurs before a package has been uninstalled.
- **post-package-uninstall**: occurs after a package has been uninstalled.
### Plugin Events
- **command**: occurs before any Composer Command is executed on the CLI. It
provides you with access to the input and output objects of the program.
- **pre-file-download**: occurs before files are downloaded and allows
you to manipulate the `RemoteFilesystem` object prior to downloading files
based on the URL to be downloaded.
> **Note:** Composer makes no assumptions about the state of your dependencies > **Note:** Composer makes no assumptions about the state of your dependencies
> prior to `install` or `update`. Therefore, you should not specify scripts > prior to `install` or `update`. Therefore, you should not specify scripts
@ -96,6 +112,7 @@ that might be used to execute the PHP callbacks:
namespace MyVendor; namespace MyVendor;
use Composer\Script\Event; use Composer\Script\Event;
use Composer\Installer\PackageEvent;
class MyClass class MyClass
{ {
@ -105,7 +122,7 @@ class MyClass
// do stuff // do stuff
} }
public static function postPackageInstall(Event $event) public static function postPackageInstall(PackageEvent $event)
{ {
$installedPackage = $event->getOperation()->getPackage(); $installedPackage = $event->getOperation()->getPackage();
// do stuff // do stuff
@ -118,14 +135,21 @@ class MyClass
} }
``` ```
When an event is fired, Composer's internal event handler receives a When an event is fired, your PHP callback receives as first argument an
`Composer\Script\Event` object, which is passed as the first argument to your `Composer\EventDispatcher\Event` object. This object has a `getName()` method
PHP callback. This `Event` object has getters for other contextual objects: that lets you retrieve event name.
- `getComposer()`: returns the current instance of `Composer\Composer` Depending on the script types (see list above) you will get various event
- `getName()`: returns the name of the event being fired as a string subclasses containing various getters with relevant data and associated
- `getIO()`: returns the current input/output stream which implements objects:
`Composer\IO\IOInterface` for writing to the console
- Base class: [`Composer\EventDispatcher\Event`](https://getcomposer.org/apidoc/master/Composer/EventDispatcher/Event.html)
- Command Events: [`Composer\Script\Event`](https://getcomposer.org/apidoc/master/Composer/Script/Event.html)
- Installer Events: [`Composer\Installer\InstallerEvent`](https://getcomposer.org/apidoc/master/Composer/Installer/InstallerEvent.html)
- Package Events: [`Composer\Installer\PackageEvent`](https://getcomposer.org/apidoc/master/Composer/Installer/PackageEvent.html)
- Plugin Events:
- command: [`Composer\Plugin\CommandEvent`](https://getcomposer.org/apidoc/master/Composer/Plugin/CommandEvent.html)
- pre-file-download: [`Composer\Plugin\PreFileDownloadEvent`](https://getcomposer.org/apidoc/master/Composer/Plugin/PreFileDownloadEvent.html)
## Running scripts manually ## Running scripts manually