sebastian/version Documentation

You can install this library as a project dependency or a development-only dependency using Composer.

To add it as a local, per-project dependency:

composer require sebastian/version

To add it as a development-time dependency (e.g., for running test suites):

composer require --dev sebastian/version

The SebastianBergmann\Version class manages version numbers for Git-hosted PHP projects.

To instantiate the class, provide two parameters to the constructor:

1. $release: The version number of the latest release (e.g., X.Y.Z) or the name of the release series (e.g., X.Y).
2. $path: The path to the directory where the project sourcecode is located (e.g., __DIR__).

Use the asString() method to retrieve the formatted version string.

<?php declare(strict_types=1);
use SebastianBergmann\Version;

$version = new Version('1.0.0', __DIR__);

var_dump($version->asString());

The output of asString() depends on whether the provided $path is part of a Git repository and the format of the $release string provided to the constructor: