PHPFUI/InstaDoc

Version parser.

author Jordi Boggiano

CloneableInstantiable

Methods

public normalize( $version, $fullVersion = NULL)

Normalizes a version string to be able to perform comparisons on it.

param string $version
param ?string $fullVersion optional complete version string to give more context
throws \UnexpectedValueException
return string

public normalizeBranch( $name)

Normalizes a branch name to be able to perform comparisons on it.

param string $name
return string

public normalizeDefaultBranch( $name)

Normalizes a default branch name (i.e. master on git) to 9999999-dev.

param string $name
return string
deprecated No need to use this anymore in theory, Composer 2 does not normalize any branch names to 9999999-dev anymore

public static normalizeStability( $stability)

param string $stability
return string
phpstan-return 'stable'|'RC'|'beta'|'alpha'|'dev'

public parseConstraints( $constraints)

Parses a constraint string into MultiConstraint and/or Constraint objects.

param string $constraints
return \ConstraintInterface

public parseNumericAliasPrefix( $branch)

Extract numeric prefix from alias, if it is in numeric format, suitable for version comparison.

param string $branch Branch name (e.g. 2.1.x-dev)
return string|false Numeric prefix if present (e.g. 2.1.) or false

public static parseStability( $version)

Returns the stability of a version.

param string $version
return string
phpstan-return 'stable'|'RC'|'beta'|'alpha'|'dev'

Properties

private static $modifierRegex = '[._-]?(?:(stable|beta|b|RC|alpha|a|patch|pl|p)((?:[.-]?\d+)*+)?)?([.-]?dev)?'

Regex to match pre-release data (sort of).

Due to backwards compatibility:

Instead of enforcing hyphen, an underscore, dot or nothing at all are also accepted.
Only stabilities as recognized by Composer are allowed to precede a numerical identifier.
Numerical-only pre-release identifiers are not supported, see tests.
```
               |--------------|
```

[major].[minor].[patch] -[pre-release] +[build-metadata]

var string

private static $stabilitiesRegex = 'stable|RC|beta|alpha|dev'

var string

Methods

private expandStability( $stability)

Expand shorthand stability string to long version.

param string $stability
return string

private manipulateVersionString(array $matches, $position, $increment = 0, $pad = '0')

Increment, decrement, or simply pad a version number.

Support function for {@link parseConstraint()}

param array $matches Array with version parts in array indexes 1,2,3,4
param int $position 1,2,3,4 - which segment of the version to increment/decrement
param int $increment
param string $pad The string to pad version parts after $position
return string|null The new version
phpstan-param string[] $matches

private parseConstraint( $constraint)

param string $constraint
throws \UnexpectedValueException
return array
phpstan-return non-empty-array<ConstraintInterface>

Properties

private static $modifierRegex = '[._-]?(?:(stable|beta|b|RC|alpha|a|patch|pl|p)((?:[.-]?\d+)*+)?)?([.-]?dev)?'

Regex to match pre-release data (sort of).

Due to backwards compatibility:

Instead of enforcing hyphen, an underscore, dot or nothing at all are also accepted.
Only stabilities as recognized by Composer are allowed to precede a numerical identifier.
Numerical-only pre-release identifiers are not supported, see tests.
```
               |--------------|
```

[major].[minor].[patch] -[pre-release] +[build-metadata]

var string

private static $stabilitiesRegex = 'stable|RC|beta|alpha|dev'

var string

Methods

public static normalizeStability( $stability)

param string $stability
return string
phpstan-return 'stable'|'RC'|'beta'|'alpha'|'dev'

public static parseStability( $version)

Returns the stability of a version.

param string $version
return string
phpstan-return 'stable'|'RC'|'beta'|'alpha'|'dev'

ConfigurationCode Formating StyleTab Stop SpacesNumbers (0-9.) only