Version

About 1 min

The version class

Handy for comparing version numbers such as 1.0 vs 1.3 or even 2.3.6 vs 1.6.3.7.32

Properties

public string $default_delimiter = '.'

public int $__precision

private string $__version = 'none'

private array $__version_parts

Version constructor.

public __construct(string $version, ?int $precision, ?string $delimiter): void

Parameter	Type	Description
`$version`	`string`	string The version number as a string
`$precision`	`int`
`$delimiter`	`string`

Magic method to output the version as a string.

public __toString(): void

public format(string $version, int $precision, ?string $delimiter): string

Sets the version string and updates the version parts and precision.

public set(string $version, ?string $delimiter): void

Parameter	Type	Description
`$version`	`string`	the version string to set
`$delimiter`	`string`	The delimiter used in the version string. If null, the default delimiter is used.

public get(): void

Get the version parts as an array.

public getParts(): void

Compare the version to another version.

public compareTo(Version $that, ?string $delimiter): void

Returns an integer indicating the result:

Parameter	Type	Description
`$that`	`Version`	The version to compare against. Can be either a version string or another version object.
`$delimiter`	`string`

Compares two versions to see if they are equal.

public equals(Version $that): bool

Parameter	Type	Description
`$that`	`Version`	The version to compare to

Sets the current version to the given version if the given version is higher.

public setIfHigher(Version $version, ?string $delimiter): void

Parameter	Type	Description
`$version`	`Version`	the version to compare against the current version
`$delimiter`	`string`	optional delimiter used for version comparison

Sets the current version to the given version if the given version is lower.

public setIfLower(Version $version, ?string $delimiter): void

Parameter	Type	Description
`$version`	`Version`	the version to compare against the current version
`$delimiter`	`string`	optional delimiter to use for version comparison