1. class
  2. Drupal
  3. \
  4. update
  5. \
  6. ModuleVersion

ModuleVersion deprecated

final class ModuleVersion (View source)

deprecated in drupal:9.2.0 and is removed from drupal:10.0.0. Use \Drupal\Core\Extension\ExtensionVersion instead. As an internal class ExtensionVersion may also be removed in a minor release.

internal  
 

Provides a module version value object.

Constants

CORE_PREFIX

The '8.x-' prefix is used on contrib module version numbers.

Properties

protected string $majorVersion

The major version.
protected string|null $versionExtra

The version extra string.

Methods

static ModuleVersion
createFromVersionString(string $version_string)

Constructs a module version object from a version string.

static ModuleVersion
createFromSupportBranch(string $branch)

Constructs a module version object from a support branch.

string
getMajorVersion()

Gets the major version.

string|null
getVersionExtra()

Gets the version extra string at the end of the version number.

Details

at line 55
static ModuleVersion createFromVersionString(string $version_string)

Constructs a module version object from a version string.

Parameters

string $version_string

The version string.

Return Value

ModuleVersion

The module version instance.

Exceptions

UnexpectedValueException

at line 116
static ModuleVersion createFromSupportBranch(string $branch)

Constructs a module version object from a support branch.

This can be used to determine the major version of the branch. ::getVersionExtra() will always return NULL for branches.

Parameters

string $branch

The support branch.

Return Value

ModuleVersion

The module version instance.

Exceptions

UnexpectedValueException

at line 129
string getMajorVersion()

Gets the major version.

Return Value

string

The major version.

at line 139
string|null getVersionExtra()

Gets the version extra string at the end of the version number.

Return Value

string|null

The version extra string if available, or otherwise NULL.