class PreFileDownloadEvent

The pre file download event.

@author Nils Adermann <naderman@naderman.de>

Hierarchy

class \Composer\EventDispatcher\Event
- class \Composer\Plugin\PreFileDownloadEvent extends \Composer\EventDispatcher\Event

Expanded class hierarchy of PreFileDownloadEvent

2 files declare their use of PreFileDownloadEvent

ComposerRepository.php in vendor/composer/composer/src/Composer/Repository/ComposerRepository.php
FileDownloader.php in vendor/composer/composer/src/Composer/Downloader/FileDownloader.php

File

vendor/composer/composer/src/Composer/Plugin/PreFileDownloadEvent.php, line 23

Namespace

Composer\Plugin

View source

class PreFileDownloadEvent extends Event {
    
    /**
     * @var HttpDownloader
     */
    private $httpDownloader;
    
    /**
     * @var non-empty-string
     */
    private $processedUrl;
    
    /**
     * @var string|null
     */
    private $customCacheKey;
    
    /**
     * @var string
     */
    private $type;
    
    /**
     * @var mixed
     */
    private $context;
    
    /**
     * @var mixed[]
     */
    private $transportOptions = [];
    
    /**
     * Constructor.
     *
     * @param string           $name           The event name
     * @param mixed            $context
     * @param non-empty-string $processedUrl
     */
    public function __construct(string $name, HttpDownloader $httpDownloader, string $processedUrl, string $type, $context = null) {
        parent::__construct($name);
        $this->httpDownloader = $httpDownloader;
        $this->processedUrl = $processedUrl;
        $this->type = $type;
        $this->context = $context;
    }
    public function getHttpDownloader() : HttpDownloader {
        return $this->httpDownloader;
    }
    
    /**
     * Retrieves the processed URL that will be downloaded.
     *
     * @return non-empty-string
     */
    public function getProcessedUrl() : string {
        return $this->processedUrl;
    }
    
    /**
     * Sets the processed URL that will be downloaded.
     *
     * @param non-empty-string $processedUrl New processed URL
     */
    public function setProcessedUrl(string $processedUrl) : void {
        $this->processedUrl = $processedUrl;
    }
    
    /**
     * Retrieves a custom package cache key for this download.
     */
    public function getCustomCacheKey() : ?string {
        return $this->customCacheKey;
    }
    
    /**
     * Sets a custom package cache key for this download.
     *
     * @param string|null $customCacheKey New cache key
     */
    public function setCustomCacheKey(?string $customCacheKey) : void {
        $this->customCacheKey = $customCacheKey;
    }
    
    /**
     * Returns the type of this download (package, metadata).
     */
    public function getType() : string {
        return $this->type;
    }
    
    /**
     * Returns the context of this download, if any.
     *
     * If this download is of type package, the package object is returned.
     * If the type is metadata, an array{repository: RepositoryInterface} is returned.
     *
     * @return mixed
     */
    public function getContext() {
        return $this->context;
    }
    
    /**
     * Returns transport options for the download.
     *
     * Only available for events with type metadata, for packages set the transport options on the package itself.
     *
     * @return mixed[]
     */
    public function getTransportOptions() : array {
        return $this->transportOptions;
    }
    
    /**
     * Sets transport options for the download.
     *
     * Only available for events with type metadata, for packages set the transport options on the package itself.
     *
     * @param mixed[] $options
     */
    public function setTransportOptions(array $options) : void {
        $this->transportOptions = $options;
    }

}

Members

Title Sort descending	Modifiers	Object type	Summary	Overriden Title
Event::$args	protected	property
Event::$flags	protected	property
Event::$name	protected	property
Event::$propagationStopped	private	property
Event::getArguments	public	function	Returns the event's arguments.
Event::getFlags	public	function	Returns the event's flags.
Event::getName	public	function	Returns the event's name.
Event::isPropagationStopped	public	function	Checks if stopPropagation has been called
Event::stopPropagation	public	function	Prevents the event from being passed to further listeners
PreFileDownloadEvent::$context	private	property
PreFileDownloadEvent::$customCacheKey	private	property
PreFileDownloadEvent::$httpDownloader	private	property
PreFileDownloadEvent::$processedUrl	private	property
PreFileDownloadEvent::$transportOptions	private	property
PreFileDownloadEvent::$type	private	property
PreFileDownloadEvent::getContext	public	function	Returns the context of this download, if any.
PreFileDownloadEvent::getCustomCacheKey	public	function	Retrieves a custom package cache key for this download.
PreFileDownloadEvent::getHttpDownloader	public	function
PreFileDownloadEvent::getProcessedUrl	public	function	Retrieves the processed URL that will be downloaded.
PreFileDownloadEvent::getTransportOptions	public	function	Returns transport options for the download.
PreFileDownloadEvent::getType	public	function	Returns the type of this download (package, metadata).
PreFileDownloadEvent::setCustomCacheKey	public	function	Sets a custom package cache key for this download.
PreFileDownloadEvent::setProcessedUrl	public	function	Sets the processed URL that will be downloaded.
PreFileDownloadEvent::setTransportOptions	public	function	Sets transport options for the download.
PreFileDownloadEvent::__construct	public	function	Constructor.	Overrides Event::__construct