You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

61 lines
2.3 KiB

3 years ago
  1. # Version
  2. Library for handling version information and constraints
  3. [![Build Status](https://travis-ci.org/phar-io/version.svg?branch=master)](https://travis-ci.org/phar-io/version)
  4. ## Installation
  5. You can add this library as a local, per-project dependency to your project using [Composer](https://getcomposer.org/):
  6. composer require phar-io/version
  7. If you only need this library during development, for instance to run your project's test suite, then you should add it as a development-time dependency:
  8. composer require --dev phar-io/version
  9. ## Version constraints
  10. A Version constraint describes a range of versions or a discrete version number. The format of version numbers follows the schema of [semantic versioning](http://semver.org): `<major>.<minor>.<patch>`. A constraint might contain an operator that describes the range.
  11. Beside the typical mathematical operators like `<=`, `>=`, there are two special operators:
  12. *Caret operator*: `^1.0`
  13. can be written as `>=1.0.0 <2.0.0` and read as »every Version within major version `1`«.
  14. *Tilde operator*: `~1.0.0`
  15. can be written as `>=1.0.0 <1.1.0` and read as »every version within minor version `1.1`. The behavior of tilde operator depends on whether a patch level version is provided or not. If no patch level is provided, tilde operator behaves like the caret operator: `~1.0` is identical to `^1.0`.
  16. ## Usage examples
  17. Parsing version constraints and check discrete versions for compliance:
  18. ```php
  19. use PharIo\Version\Version;
  20. use PharIo\Version\VersionConstraintParser;
  21. $parser = new VersionConstraintParser();
  22. $caret_constraint = $parser->parse( '^7.0' );
  23. $caret_constraint->complies( new Version( '7.0.17' ) ); // true
  24. $caret_constraint->complies( new Version( '7.1.0' ) ); // true
  25. $caret_constraint->complies( new Version( '6.4.34' ) ); // false
  26. $tilde_constraint = $parser->parse( '~1.1.0' );
  27. $tilde_constraint->complies( new Version( '1.1.4' ) ); // true
  28. $tilde_constraint->complies( new Version( '1.2.0' ) ); // false
  29. ```
  30. As of version 2.0.0, pre-release labels are supported and taken into account when comparing versions:
  31. ```php
  32. $leftVersion = new PharIo\Version\Version('3.0.0-alpha.1');
  33. $rightVersion = new PharIo\Version\Version('3.0.0-alpha.2');
  34. $leftVersion->isGreaterThan($rightVersion); // false
  35. $rightVersion->isGreaterThan($leftVersion); // true
  36. ```