You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
187 lines
7.2 KiB
PHP
187 lines
7.2 KiB
PHP
<?php
|
|
|
|
namespace Composer;
|
|
|
|
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
|
|
{
|
|
private static $installed;
|
|
|
|
/**
|
|
* 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()
|
|
{
|
|
return array_keys(self::$installed['versions']);
|
|
}
|
|
|
|
/**
|
|
* 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)
|
|
{
|
|
return isset(self::$installed['versions'][$packageName]);
|
|
}
|
|
|
|
/**
|
|
* 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 $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)
|
|
{
|
|
$constraint = $parser->parseConstraints($constraint);
|
|
$provided = $parser->parseConstraints(self::getVersionRanges($packageName));
|
|
|
|
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)
|
|
{
|
|
if (!isset(self::$installed['versions'][$packageName])) {
|
|
throw new \OutOfBoundsException('Package "' . $packageName . '" is not installed');
|
|
}
|
|
|
|
$ranges = array();
|
|
if (isset(self::$installed['versions'][$packageName]['pretty_version'])) {
|
|
$ranges[] = self::$installed['versions'][$packageName]['pretty_version'];
|
|
}
|
|
if (array_key_exists('aliases', self::$installed['versions'][$packageName])) {
|
|
$ranges = array_merge($ranges, self::$installed['versions'][$packageName]['aliases']);
|
|
}
|
|
if (array_key_exists('replaced', self::$installed['versions'][$packageName])) {
|
|
$ranges = array_merge($ranges, self::$installed['versions'][$packageName]['replaced']);
|
|
}
|
|
if (array_key_exists('provided', self::$installed['versions'][$packageName])) {
|
|
$ranges = array_merge($ranges, self::$installed['versions'][$packageName]['provided']);
|
|
}
|
|
|
|
return implode(' || ', $ranges);
|
|
}
|
|
|
|
/**
|
|
* @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)
|
|
{
|
|
if (!isset(self::$installed['versions'][$packageName])) {
|
|
throw new \OutOfBoundsException('Package "' . $packageName . '" is not installed');
|
|
}
|
|
|
|
if (!isset(self::$installed['versions'][$packageName]['version'])) {
|
|
return null;
|
|
}
|
|
|
|
return self::$installed['versions'][$packageName]['version'];
|
|
}
|
|
|
|
/**
|
|
* @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)
|
|
{
|
|
if (!isset(self::$installed['versions'][$packageName])) {
|
|
throw new \OutOfBoundsException('Package "' . $packageName . '" is not installed');
|
|
}
|
|
|
|
if (!isset(self::$installed['versions'][$packageName]['pretty_version'])) {
|
|
return null;
|
|
}
|
|
|
|
return self::$installed['versions'][$packageName]['pretty_version'];
|
|
}
|
|
|
|
/**
|
|
* @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)
|
|
{
|
|
if (!isset(self::$installed['versions'][$packageName])) {
|
|
throw new \OutOfBoundsException('Package "' . $packageName . '" is not installed');
|
|
}
|
|
|
|
if (!isset(self::$installed['versions'][$packageName]['reference'])) {
|
|
return null;
|
|
}
|
|
|
|
return self::$installed['versions'][$packageName]['reference'];
|
|
}
|
|
|
|
/**
|
|
* @return array
|
|
* @psalm-return array{name: string, version: string, reference: string, pretty_version: string, aliases: string[]}
|
|
*/
|
|
public static function getRootPackage()
|
|
{
|
|
return self::$installed['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()
|
|
{
|
|
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)
|
|
{
|
|
self::$installed = $data;
|
|
}
|
|
}
|