1. class
  2. Drupal
  3. \
  4. Core
  5. \
  6. Update
  7. \
  8. UpdateHookRegistry

UpdateHookRegistry

class UpdateHookRegistry (View source)

Provides module updates versions handling.

Constants

SCHEMA_UNINSTALLED

Indicates that a module has not been installed yet.

Properties

protected string[] $enabledModules

A list of enabled modules.
protected KeyValueStoreInterface $keyValue

The key value storage.
protected int[][] $allAvailableSchemaVersions

A static cache of schema currentVersions per module.

Methods

__construct(array $enabled_modules, KeyValueStoreInterface $key_value)

Constructs a new UpdateRegistry.

array
getAvailableUpdates(string $module)

Returns an array of available schema versions for a module.

int
getInstalledVersion(string $module)

Returns the currently installed schema version for a module.

UpdateHookRegistry
setInstalledVersion(string $module, int $version)

Updates the installed version information for a module.

void
deleteInstalledVersion(string $module)

Deletes the installed version information for the module.

array
getAllInstalledVersions()

Returns the currently installed schema version for all modules.

Details

at line 60
__construct(array $enabled_modules, KeyValueStoreInterface $key_value)

Constructs a new UpdateRegistry.

Parameters

array $enabled_modules

A list of enabled modules.
KeyValueStoreInterface $key_value

The key value store.

at line 75
array getAvailableUpdates(string $module)

Returns an array of available schema versions for a module.

Parameters

string $module

A module name.

Return Value

array

An array of available updates sorted by version. Empty array returned if no updates available.

at line 122
int getInstalledVersion(string $module)

Returns the currently installed schema version for a module.

Parameters

string $module

A module name.

Return Value

int

The currently installed schema version, or self::SCHEMA_UNINSTALLED if the module is not installed.

at line 137
UpdateHookRegistry setInstalledVersion(string $module, int $version)

Updates the installed version information for a module.

Parameters

string $module

A module name.
int $version

The new schema version.

Return Value

UpdateHookRegistry

Returns self to support chained method calls.

at line 148
void deleteInstalledVersion(string $module)

Deletes the installed version information for the module.

Parameters

string $module

The module name to delete.

Return Value

void

at line 160
array getAllInstalledVersions()

Returns the currently installed schema version for all modules.

Return Value

array

Array of modules as the keys and values as the currently installed schema version of corresponding module, or self::SCHEMA_UNINSTALLED if the module is not installed.