vdechenaux / package-versions
Composer plugin that provides efficient querying for installed package versions (no runtime IO)
Installs: 8
Dependents: 0
Suggesters: 0
Security: 0
Stars: 0
Watchers: 2
Forks: 69
Type:composer-plugin
Requires
- php: ^7.1.0
- composer-plugin-api: ^1.0.0
Requires (Dev)
- ext-zip: *
- composer/composer: ^1.6.3
- infection/infection: ^0.7.1
- phpunit/phpunit: ^7.0.0
README
This utility provides quick and easy access to version information of composer dependencies.
This information is derived from the composer.lock
file which is (re)generated during composer install
or composer update
.
$version = \PackageVersions\Versions::getVersion('ocramius/package-versions'); var_dump($version); // 1.0.0@0beec7b5ea3f0fdbc95d0dd47f3c5bc275da8a33
Installation
composer require ocramius/package-versions
It is suggested that you use a optimized composer autoloader in order to prevent
autoload I/O when accessing the PackageVersions\Versions
API:
Therefore you should use optimize-autoloader: true
in your composer.json:
...
"config": {
"optimize-autoloader": true
},
...
see https://getcomposer.org/doc/06-config.md#optimize-autoloader
In case you manually generate your autoloader via the CLI use the --optimize
flag:
composer dump-autoload --optimize
Use-cases
This repository implements PackageVersions\Versions::getVersion()
in such a way that no IO
happens when calling it, because the list of package versions is compiled during composer
installation.
This is especially useful when you want to generate assets/code/artifacts that are computed from the current version of a certain dependency. Doing so at runtime by checking the installed version of a package would be too expensive, and this package mitigates that.