abstract class Configuration implements ConfigurationInterface (View source)

Abstract Migration Configuration as a base for different configuration sources.

Properties

protected array<string, mixed>|null $availableVersions
protected array<string, mixed> $loadedVersions

Methods

array<string, mixed>
getAvailableVersions()

Returns an array with all available versions.

bool
isVersionAvailable(string $version)

If the given version is available, true is returned.

array<string, mixed>
getMigrationVersion(string|int $version)

Returns the configuration of the given version, if available.

bool
isVersionLoaded(string $version)

Check if the given version has been loaded already.

array<string, mixed>
loadConfiguration(string $version)

Loads a specific version into an array.

void
registerAvailableVersions()

Loads a list of available versions into an array.

Details

array<string, mixed> getAvailableVersions()

Returns an array with all available versions.

Return Value

array<string, mixed>

bool isVersionAvailable(string $version)

If the given version is available, true is returned.

Parameters

string $version

Return Value

bool

array<string, mixed> getMigrationVersion(string|int $version)

Returns the configuration of the given version, if available.

Parameters

string|int $version

Return Value

array<string, mixed>

Exceptions

MigrationException

protected bool isVersionLoaded(string $version)

Check if the given version has been loaded already.

Parameters

string $version

Return Value

bool

abstract protected array<string, mixed> loadConfiguration(string $version)

Loads a specific version into an array.

Parameters

string $version

Return Value

array<string, mixed>

abstract protected void registerAvailableVersions()

Loads a list of available versions into an array.

Return Value

void