MoodleVersion

A regular expression for matching human-friendly Moodle release strings. This RE is case-insensitive and will allow for the optional pre-fixing of the word Moodle with or whithout a separating space.

See:

• ReleaseString

A regular expression for matching under-the-hood version numbers like '2017051506' or '2017051506.00'.

See:

• VersionNumber

A regular expression for matching short version strings like '3.5+' (as used on the Moodle download page). This RE is case-insensitive and will allow for the optional pre-fixing of the word Moodle with or whithout a separating space.

See:

• VersionString

Convert a branch number into a branch string, i.e. 35 to '3.5' and 310 to '3.10'.

Convert a branching date number to a branch, e.g. 20180517 to '3.5'.

Convert a branch string into a branch number, i.e. '3.5' to 35.

Convert a branching date number to a branch number, e.g. 20180517 to 35.

Convert a branch to a branching date number, e.g. '3.5' to 20180517.

Convert a branch number to a branching date number, e.g. 35 to 20180517.

Compare two values to see if they represent the same version, a greater version, or a lesser version.

When ranking versions, the branch is given the highest weight, then the release number, then the release type, and finally the build number. When comparing release types, 'development' is considered earlier 'official', which is considered earlier than 'weekly'.

Convert a date number to a date object. The date object will represent midnight UTC on the given date.

Throw:

Convert a date object to a date number. The date will be interpreted as UTC.

Throw:

A factory method for producing a Moodle Version object given all its properties.

If only one of the branch and branching date are passed, and if a known mapping exists, the other is auto-completed.

This function can be used to create version objects which contain unknown mappings between Moodle branches and branching dates.

Throw:

Build a version object from a version string. The vesion string can be in one of the following formats:

• A human-friendly full release string (ReleaseString), e.g. 'Moodle 3.5+ (Build: 20180614)' (will be accepted with or without the 'Moodle' prefix).
• A human-friendly short version string (VersionString), e.g. 'Moodle 3.3.6+' (will be accepted with or without the 'Moodle' prefix).
• An under-the-hood version number (VersionNumber), e.g.
• '2017051506' or '2017051506.00'.
• A string as returned by calling .toString() on an instance of this class.

Throw:

See:

• ReleaseString
• VersionString
• VersionNumber
• MoodleVersion#toString

Test if a given value is a branch string, e.g. '3.5' or '3.10'.

Test if a given value is a branch number, e.g. 35, '35', 310 or `'310'.

Test if a given value is a date number, i.e. an 8-digit number of the form YYYYMMDD.

Test if a given value is a release number.

Note that if strict type checking is not enabled, the empty string is considered a valid release number, being synonymous with zero in Moodle release strings.

Test if a given value is a valid release suffix.

See:

• ReleaseSuffix

Test if a given value is a valid release type.

See:

• ReleaseType

Convert a release type to a number. Useful for version comparisons.

All invalid values convert to 0, 'development' to 1, 'official' to 2, and 'weekly' to 3.

Convert a release type to a release suffix, e.g. 'weekly' to '+'.

Convert a relase suffix to a release type, e.g. '+' to 'weekly'.

By default version objects contain no information.

If a string is passed, the object is initialised using MoodleVersion.fromString, and if an object is passed then MoodleVersion.fromObject is used instead.

Throw:

The major version part of the version number, officially known as the branch.

For example, the branch for each of the 3.4, 3.4+, 3.4.1, and 3.4.1+ releases is '3.4'.

The branch (AKA major version) must be a string consisting of two digits separated by a period, e.g. '3.5'.

Setting the branch will also update the branching date to match.

To create an object with an un-known combination of branch and branching date, use the MoodleVersion.fromObject factory method.

Throw:

The version's branch number, if known. This is the two-digit number used internally within the Moodle code to identify a branch, or major release.

For example, all Moodle 3.5.* releases will have the branch number 35.

The branch number must be a two-digit integer between 10 and 99.

Setting the branch number will also update the branching date to match.

To create an object with an un-known combination of branch and branching date, use the MoodleVersion.fromObject factory method.

Throw:

The known mappings between branching date numbers and Moodle branch numbers.

@type{Map<DateNumber, BranchNumber>}

The known mappings between branching date numbers and Moodle branches.

@type{Map<DateNumber, Branch>}

The branching date as a date object.

Setting the branching date will update the branch to match.

To create an object with an un-known combination of branch and branching date, use the MoodleVersion.fromObject factory method.

@type{Date|undefined}

Throw:

The branching date as a DateNumber.

Setting the branching date will update the branch to match.

To create an object with an un-known combination of branch and branching date, use the MoodleVersion.fromObject factory method.

@type{DateNumber|undefined}

Throw:

The known mappings between Moodle braches and branching date numbers.

@type{Map<Branch, DateNumber>}

The known mappings between Moodle brache numberss and branching date numbers.

@type{Map<BranchNumber, DateNumber>}

The build number.

Build numbers must be valid date numbers, i.e. of the form YYYYMMDD.

Throw:

The long human-friendly form of the version information.

In keeping with how Moodle presents version strings, release numbers of zero are omitted. If the release type is unknown no suffix is appended. If the branch is unknown it is represented as '??.??', if the release number is unknown it's represented as '.??', and if the build number is unknown it's represented as '????????'.

The release number part of the version number.

The release number must be an integer greater than or equal to zero.

Throw:

The release suffix for the release's type, e.g. '+' for weekly updates to the official releases.

The release suffix must be one of 'dev', an empty string, or '+'. The value will get automatically cast to lower case before validation is applied.

Throw:

The release's type, e.g. 'development'.

The release type must be one of 'development', 'official', or 'weekly'. The value will get automatically cast to lower case before validation is applied.

Throw:

The short human-friendly form of the version number.

In keeping with how Moodle presents version strings, release numbers of zero are omitted. If the release type is unknown no suffix is appended. If the branch is unknown it is represented as '??.??', and if the release number is unknown it's represented as '.??'.

The under-the-hood form of the version number.

If the branch is unknown its replaced with eight question marks, and if the release number is unknown it's replaced with two.

Determine whether this version is greater than or equal to the given version.

Create a new Moodle version object representing the same version information.

Compare this version to another.

Test if a given value is a Moodle Version object representing the same version.

Determine whether this version is greater than a given version.

Is this version on a branch the library knows about?

Determine whether or not this is version is on a long-term support branch. If the branch is not defined or unknown, undefined is returned.

Is this a stable release? I.e. is the release type official or weekly?

Determine whether this version is less than a given version.

Determine whether this versions is on the same branch as a given version.

The version as a plain object indexed by zero or more of:

• version
• versionNumber
• release
• branch
• branchNumber
• branchingDateNumber
• branchingDate
• releaseNumber
• releaseType
• releaseSuffix
• buildNumber

An array containing a SemVer (Semantic Versioning) representation of the version information. The first element will be the major version number, the second the minor, and the third the patch.

An object containing a SemVer (Semantic Versioning) representation of the version information.

Return a string representation of the version. The output will be of the form B.B.R[S] (type: T, branching date: BD & build: BN), e.g. 3.3.6 (type: official, branching date: 20170515 & build: 20180517). Undefined components will be rendered as ??.