class PluginEvents

The Plugin Events.

@author Nils Adermann <naderman@naderman.de>

Hierarchy

Expanded class hierarchy of PluginEvents

20 files declare their use of PluginEvents
ArchiveCommand.php in vendor/composer/composer/src/Composer/Command/ArchiveCommand.php
BaseCommand.php in vendor/composer/composer/src/Composer/Command/BaseCommand.php
BaseDependencyCommand.php in vendor/composer/composer/src/Composer/Command/BaseDependencyCommand.php
ComposerRepository.php in vendor/composer/composer/src/Composer/Repository/ComposerRepository.php
DiagnoseCommand.php in vendor/composer/composer/src/Composer/Command/DiagnoseCommand.php

... See full list

File

vendor/composer/composer/src/Composer/Plugin/PluginEvents.php, line 20

Namespace

Composer\Plugin
View source 
class PluginEvents {
    
    /**
     * The INIT event occurs after a Composer instance is done being initialized
     *
     * The event listener method receives a
     * Composer\EventDispatcher\Event instance.
     *
     * @var string
     */
    public const INIT = 'init';
    
    /**
     * The COMMAND event occurs as a command begins
     *
     * The event listener method receives a
     * Composer\Plugin\CommandEvent instance.
     *
     * @var string
     */
    public const COMMAND = 'command';
    
    /**
     * The PRE_FILE_DOWNLOAD event occurs before downloading a file
     *
     * The event listener method receives a
     * Composer\Plugin\PreFileDownloadEvent instance.
     *
     * @var string
     */
    public const PRE_FILE_DOWNLOAD = 'pre-file-download';
    
    /**
     * The POST_FILE_DOWNLOAD event occurs after downloading a package dist file
     *
     * The event listener method receives a
     * Composer\Plugin\PostFileDownloadEvent instance.
     *
     * @var string
     */
    public const POST_FILE_DOWNLOAD = 'post-file-download';
    
    /**
     * The PRE_COMMAND_RUN event occurs before a command is executed and lets you modify the input arguments/options
     *
     * The event listener method receives a
     * Composer\Plugin\PreCommandRunEvent instance.
     *
     * @var string
     */
    public const PRE_COMMAND_RUN = 'pre-command-run';
    
    /**
     * The PRE_POOL_CREATE event occurs before the Pool of packages is created, and lets
     * you filter the list of packages which is going to enter the Solver
     *
     * The event listener method receives a
     * Composer\Plugin\PrePoolCreateEvent instance.
     *
     * @var string
     */
    public const PRE_POOL_CREATE = 'pre-pool-create';

}

Members

Title Modifiers Object type Summary
PluginEvents::COMMAND public constant The COMMAND event occurs as a command begins
PluginEvents::INIT public constant The INIT event occurs after a Composer instance is done being initialized
PluginEvents::POST_FILE_DOWNLOAD public constant The POST_FILE_DOWNLOAD event occurs after downloading a package dist file
PluginEvents::PRE_COMMAND_RUN public constant The PRE_COMMAND_RUN event occurs before a command is executed and lets you modify the input arguments/options
PluginEvents::PRE_FILE_DOWNLOAD public constant The PRE_FILE_DOWNLOAD event occurs before downloading a file
PluginEvents::PRE_POOL_CREATE public constant The PRE_POOL_CREATE event occurs before the Pool of packages is created, and lets
you filter the list of packages which is going to enter the Solver