Documentation

VersionGuesser
in package

Try to guess the current version number based on different VCS configuration.

Tags
author

Jordi Boggiano j.boggiano@seld.be

author

Samuel Roze samuel.roze@gmail.com

Table of Contents

$config  : Config
$process  : ProcessExecutor
$versionParser  : VersionParser
__construct()  : mixed
guessVersion()  : null|array<string|int, mixed>
guessFeatureVersion()  : mixed
guessFossilVersion()  : mixed
guessGitVersion()  : mixed
guessHgVersion()  : mixed
guessSvnVersion()  : mixed
postprocess()  : mixed
versionFromGitTags()  : mixed

Properties

Methods

guessVersion()

public guessVersion(array<string|int, mixed> $packageConfig, string $path) : null|array<string|int, mixed>
Parameters
$packageConfig : array<string|int, mixed>
$path : string

Path to guess into

Return values
null|array<string|int, mixed>

versionData, 'version', 'pretty_version' and 'commit' keys, if the version is a feature branch, 'feature_version' and 'feature_pretty_version' keys may also be returned

guessFeatureVersion()

private guessFeatureVersion(array<string|int, mixed> $packageConfig, mixed $version, array<string|int, mixed> $branches, mixed $scmCmdline, mixed $path) : mixed
Parameters
$packageConfig : array<string|int, mixed>
$version : mixed
$branches : array<string|int, mixed>
$scmCmdline : mixed
$path : mixed
Return values
mixed

guessFossilVersion()

private guessFossilVersion(array<string|int, mixed> $packageConfig, mixed $path) : mixed
Parameters
$packageConfig : array<string|int, mixed>
$path : mixed
Return values
mixed

guessGitVersion()

private guessGitVersion(array<string|int, mixed> $packageConfig, mixed $path) : mixed
Parameters
$packageConfig : array<string|int, mixed>
$path : mixed
Return values
mixed

guessHgVersion()

private guessHgVersion(array<string|int, mixed> $packageConfig, mixed $path) : mixed
Parameters
$packageConfig : array<string|int, mixed>
$path : mixed
Return values
mixed

guessSvnVersion()

private guessSvnVersion(array<string|int, mixed> $packageConfig, mixed $path) : mixed
Parameters
$packageConfig : array<string|int, mixed>
$path : mixed
Return values
mixed

postprocess()

private postprocess(array<string|int, mixed> $versionData) : mixed
Parameters
$versionData : array<string|int, mixed>
Return values
mixed

versionFromGitTags()

private versionFromGitTags(mixed $path) : mixed
Parameters
$path : mixed
Return values
mixed

Search results