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

Clean stuff up and deprecate old usages for PostFileDownloadEvent

pull/9822/head
Jordi Boggiano 2021-04-09 11:00:49 +02:00
parent df0a2cdd0a
commit 7dd95a768b
No known key found for this signature in database
GPG Key ID: 7BBD42C429EC80BC
5 changed files with 17 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/Composer/Downloader/FileDownloader.php
View File

@ -192,7 +192,7 @@ class FileDownloader implements DownloaderInterface, ChangeReportInterface
}
if ($eventDispatcher) {
$postFileDownloadEvent = new PostFileDownloadEvent(PluginEvents::POST_FILE_DOWNLOAD, $fileName, $checksum, $url['processed'], $package);
$postFileDownloadEvent = new PostFileDownloadEvent(PluginEvents::POST_FILE_DOWNLOAD, $fileName, $checksum, $url['processed'], 'package', $package);
$eventDispatcher->dispatch($postFileDownloadEvent->getName(), $postFileDownloadEvent);
}

2
src/Composer/Plugin/PluginInterface.php
View File

@ -32,7 +32,7 @@ interface PluginInterface
*
* @var string
*/
const PLUGIN_API_VERSION = '2.0.0';
const PLUGIN_API_VERSION = '2.1.0';
/**
* Apply plugin modifications to Composer

13
src/Composer/Plugin/PostFileDownloadEvent.php
View File

@ -54,11 +54,17 @@ class PostFileDownloadEvent extends Event
* @param string|null $fileName The file name
* @param string|null $checksum The checksum
* @param string $url The processed url
* @param mixed $context Additional context for the download.
* @param string $type The type (package or metadata).
* @param mixed $context Additional context for the download.
*/
public function __construct($name, $fileName, $checksum, $url, $context = null, $type = 'package')
public function __construct($name, $fileName, $checksum, $url, $type, $context = null)
{
if ($context === null && $type instanceof PackageInterface) {
$context = $type;
$type = 'package';
trigger_error('PostFileDownloadEvent::__construct should receive a $type=package and the package object in $context since Composer 2.1.', E_USER_DEPRECATED);
}
parent::__construct($name);
$this->fileName = $fileName;
$this->checksum = $checksum;
@ -118,10 +124,13 @@ class PostFileDownloadEvent extends Event
* If this download is of type metadata, null is returned.
*
* @return \Composer\Package\PackageInterface|null The package.
* @deprecated Use getContext instead
*/
public function getPackage()
{
trigger_error('PostFileDownloadEvent::getPackage is deprecated since Composer 2.1, use getContext instead.', E_USER_DEPRECATED);
$context = $this->getContext();
return $context instanceof PackageInterface ? $context : null;
}

6
src/Composer/Repository/ComposerRepository.php
View File

@ -1112,7 +1112,7 @@ class ComposerRepository extends ArrayRepository implements ConfigurableReposito
}
if ($this->eventDispatcher) {
$postFileDownloadEvent = new PostFileDownloadEvent(PluginEvents::POST_FILE_DOWNLOAD, null, $sha256, $filename, $response, 'metadata');
$postFileDownloadEvent = new PostFileDownloadEvent(PluginEvents::POST_FILE_DOWNLOAD, null, $sha256, $filename, 'metadata', $response);
$this->eventDispatcher->dispatch($postFileDownloadEvent->getName(), $postFileDownloadEvent);
}
@ -1195,7 +1195,7 @@ class ComposerRepository extends ArrayRepository implements ConfigurableReposito
}
if ($this->eventDispatcher) {
$postFileDownloadEvent = new PostFileDownloadEvent(PluginEvents::POST_FILE_DOWNLOAD, null, null, $filename, $response, 'metadata');
$postFileDownloadEvent = new PostFileDownloadEvent(PluginEvents::POST_FILE_DOWNLOAD, null, null, $filename, 'metadata', $response);
$this->eventDispatcher->dispatch($postFileDownloadEvent->getName(), $postFileDownloadEvent);
}
@ -1288,7 +1288,7 @@ class ComposerRepository extends ArrayRepository implements ConfigurableReposito
}
if ($eventDispatcher) {
$postFileDownloadEvent = new PostFileDownloadEvent(PluginEvents::POST_FILE_DOWNLOAD, null, null, $url, $response, 'metadata');
$postFileDownloadEvent = new PostFileDownloadEvent(PluginEvents::POST_FILE_DOWNLOAD, null, null, $url, 'metadata', $response);
$eventDispatcher->dispatch($postFileDownloadEvent->getName(), $postFileDownloadEvent);
}

2
tests/Composer/Test/Plugin/Fixtures/plugin-v8/composer.json
View File

@ -9,6 +9,6 @@
]
},
"require": {
"composer-plugin-api": "2.0.0"
"composer-plugin-api": "^2.0.0"
}
}