@ -1,25 +1,25 @@
<?php <?php
/*
* This file is part of Composer.
*
* (c) Nils Adermann < naderman @ naderman . de >
* Jordi Boggiano < j.boggiano @ seld . be >
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Composer;
namespace Composer;
use Composer\Autoload\ClassLoader;
use Composer\Autoload\ClassLoader;
use Composer\Semver\VersionParser;
use Composer\Semver\VersionParser;
/**
* This class is copied in every Composer installed project and available to all
*
* To require it's presence, you can require `composer-runtime-api ^2.0`
*/
class InstalledVersions
class InstalledVersions
{
{
private static $installed = array (
private static $installed = array (
@ -30,7 +30,7 @@ private static $installed = array (
'aliases' =>
'aliases' =>
array (
array (
),
),
'reference' => '1baf8c521785ab4dc8f474fdd772280737c7e254 ',
'reference' => 'a73e3bec45c5523910c711cf882976b71781ac9e ',
'name' => '__root__',
'name' => '__root__',
),
),
'versions' =>
'versions' =>
@ -42,9 +42,9 @@ private static $installed = array (
'aliases' =>
'aliases' =>
array (
array (
),
),
'reference' => '1baf8c521785ab4dc8f474fdd772280737c7e254 ',
'reference' => 'a73e3bec45c5523910c711cf882976b71781ac9e ',
),
),
'andreskrey /readability.php' =>
'fivefilters /readability.php' =>
array (
array (
'pretty_version' => 'v2.1.0',
'pretty_version' => 'v2.1.0',
'version' => '2.1.0.0',
'version' => '2.1.0.0',
@ -55,24 +55,24 @@ private static $installed = array (
),
),
'psr/log' =>
'psr/log' =>
array (
array (
'pretty_version' => '1.1.3 ',
'pretty_version' => '1.1.4 ',
'version' => '1.1.3 .0',
'version' => '1.1.4 .0',
'aliases' =>
'aliases' =>
array (
array (
),
),
'reference' => '0f73288fd15629204f9d42b7055f72dacbe811fc ',
'reference' => 'd49695b909c3b7628b6289db5479a1c204601f11 ',
),
),
),
),
);
);
private static $canGetVendors;
private static $canGetVendors;
private static $installedByVendor = array();
private static $installedByVendor = array();
/**
* Returns a list of all package names which are present, either by being installed, replaced or provided
*
* @return string[]
* @psalm-return list< string >
*/
public static function getInstalledPackages()
public static function getInstalledPackages()
{
{
$packages = array();
$packages = array();
@ -88,14 +88,14 @@ return $packages[0];
return array_keys(array_flip(\call_user_func_array('array_merge', $packages)));
return array_keys(array_flip(\call_user_func_array('array_merge', $packages)));
}
}
/**
* Checks whether the given package is installed
*
* This also returns true if the package name is provided or replaced by another package
*
* @param string $packageName
* @return bool
*/
public static function isInstalled($packageName)
public static function isInstalled($packageName)
{
{
foreach (self::getInstalled() as $installed) {
foreach (self::getInstalled() as $installed) {
@ -107,19 +107,19 @@ return true;
return false;
return false;
}
}
/**
* Checks whether the given package satisfies a version constraint
*
* e.g. If you want to know whether version 2.3+ of package foo/bar is installed, you would call:
*
* Composer\InstalledVersions::satisfies(new VersionParser, 'foo/bar', '^2.3')
*
* @param VersionParser $parser Install composer/semver to have access to this class and functionality
* @param string $packageName
* @param string|null $constraint A version constraint to check for, if you pass one you have to make sure composer/semver is required by your package
*
* @return bool
*/
public static function satisfies(VersionParser $parser, $packageName, $constraint)
public static function satisfies(VersionParser $parser, $packageName, $constraint)
{
{
$constraint = $parser->parseConstraints($constraint);
$constraint = $parser->parseConstraints($constraint);
@ -128,15 +128,15 @@ $provided = $parser->parseConstraints(self::getVersionRanges($packageName));
return $provided->matches($constraint);
return $provided->matches($constraint);
}
}
/**
* Returns a version constraint representing all the range(s) which are installed for a given package
*
* It is easier to use this via isInstalled() with the $constraint argument if you need to check
* whether a given version of a package is installed, and not just whether it exists
*
* @param string $packageName
* @return string Version constraint usable with composer/semver
*/
public static function getVersionRanges($packageName)
public static function getVersionRanges($packageName)
{
{
foreach (self::getInstalled() as $installed) {
foreach (self::getInstalled() as $installed) {
@ -164,10 +164,10 @@ return implode(' || ', $ranges);
throw new \OutOfBoundsException('Package "' . $packageName . '" is not installed');
throw new \OutOfBoundsException('Package "' . $packageName . '" is not installed');
}
}
/**
* @param string $packageName
* @return string|null If the package is being replaced or provided but is not really installed, null will be returned as version, use satisfies or getVersionRanges if you need to know if a given version is present
*/
public static function getVersion($packageName)
public static function getVersion($packageName)
{
{
foreach (self::getInstalled() as $installed) {
foreach (self::getInstalled() as $installed) {
@ -185,10 +185,10 @@ return $installed['versions'][$packageName]['version'];
throw new \OutOfBoundsException('Package "' . $packageName . '" is not installed');
throw new \OutOfBoundsException('Package "' . $packageName . '" is not installed');
}
}
/**
* @param string $packageName
* @return string|null If the package is being replaced or provided but is not really installed, null will be returned as version, use satisfies or getVersionRanges if you need to know if a given version is present
*/
public static function getPrettyVersion($packageName)
public static function getPrettyVersion($packageName)
{
{
foreach (self::getInstalled() as $installed) {
foreach (self::getInstalled() as $installed) {
@ -206,10 +206,10 @@ return $installed['versions'][$packageName]['pretty_version'];
throw new \OutOfBoundsException('Package "' . $packageName . '" is not installed');
throw new \OutOfBoundsException('Package "' . $packageName . '" is not installed');
}
}
/**
* @param string $packageName
* @return string|null If the package is being replaced or provided but is not really installed, null will be returned as reference
*/
public static function getReference($packageName)
public static function getReference($packageName)
{
{
foreach (self::getInstalled() as $installed) {
foreach (self::getInstalled() as $installed) {
@ -227,10 +227,10 @@ return $installed['versions'][$packageName]['reference'];
throw new \OutOfBoundsException('Package "' . $packageName . '" is not installed');
throw new \OutOfBoundsException('Package "' . $packageName . '" is not installed');
}
}
/**
* @return array
* @psalm-return array{name: string, version: string, reference: string, pretty_version: string, aliases: string[]}
*/
public static function getRootPackage()
public static function getRootPackage()
{
{
$installed = self::getInstalled();
$installed = self::getInstalled();
@ -238,44 +238,44 @@ $installed = self::getInstalled();
return $installed[0]['root'];
return $installed[0]['root'];
}
}
/**
* Returns the raw installed.php data for custom implementations
*
* @return array[]
* @psalm-return array{root: array{name: string, version: string, reference: string, pretty_version: string, aliases: string[]}, versions: list< string , array { pretty_version: ? string , version: ? string , aliases: ? string [ ] , reference: ? string , replaced: ? string [ ] , provided: ? string [ ] } > }
*/
public static function getRawData()
public static function getRawData()
{
{
return self::$installed;
return self::$installed;
}
}
/**
* Lets you reload the static array from another file
*
* This is only useful for complex integrations in which a project needs to use
* this class but then also needs to execute another project's autoloader in process,
* and wants to ensure both projects have access to their version of installed.php.
*
* A typical case would be PHPUnit, where it would need to make sure it reads all
* the data it needs from this class, then call reload() with
* `require $CWD/vendor/composer/installed.php` (or similar) as input to make sure
* the project in which it runs can then also use this class safely, without
* interference between PHPUnit's dependencies and the project's dependencies.
*
* @param array[] $data A vendor/composer/installed.php data set
* @return void
*
* @psalm-param array{root: array{name: string, version: string, reference: string, pretty_version: string, aliases: string[]}, versions: list< string , array { pretty_version: ? string , version: ? string , aliases: ? string [ ] , reference: ? string , replaced: ? string [ ] , provided: ? string [ ] } > } $data
*/
public static function reload($data)
public static function reload($data)
{
{
self::$installed = $data;
self::$installed = $data;
self::$installedByVendor = array();
self::$installedByVendor = array();
}
}
/**
* @return array[]
*/
private static function getInstalled()
private static function getInstalled()
{
{
if (null === self::$canGetVendors) {
if (null === self::$canGetVendors) {
@ -285,6 +285,7 @@ self::$canGetVendors = method_exists('Composer\Autoload\ClassLoader', 'getRegist
$installed = array();
$installed = array();
if (self::$canGetVendors) {
if (self::$canGetVendors) {
// @phpstan-ignore-next-line
foreach (ClassLoader::getRegisteredLoaders() as $vendorDir => $loader) {
foreach (ClassLoader::getRegisteredLoaders() as $vendorDir => $loader) {
if (isset(self::$installedByVendor[$vendorDir])) {
if (isset(self::$installedByVendor[$vendorDir])) {
$installed[] = self::$installedByVendor[$vendorDir];
$installed[] = self::$installedByVendor[$vendorDir];
Nils Gotzhein
3 years ago