UpgradeWizardsService

final class \TYPO3\CMS\Core\Service\UpgradeWizardsService

Service class helps to manage upgrade wizards.

Attributes

#[Autoconfigure]
$public: true

Table of Contents

Methods

__construct()  : mixed
executeWizard()  : FlashMessageQueue
Execute a single update wizard
getNonRepeatableUpgradeWizards()  : array
getUpgradeWizard()  : UpgradeWizardInterface|null
Wrapper to catch \UnexpectedValueException for backwards compatibility reasons
getUpgradeWizardIdentifiers()  : array
getUpgradeWizardsList()  : array
Get list of registered upgrade wizards not marked done.
getWizardInformationByIdentifier()  : array
getWizardUserInput()  : array
Execute the "get user input" step of a wizard
isWizardDone()  : bool
Checks if this wizard has been "done" before
listOfRowUpdatersDone()  : array
listOfWizardsDone()  : array
markWizardAsDone()  : void
Marks some wizard as being "seen" so that it not shown again.
markWizardUndone()  : bool
Mark one wizard as undone. This can be a "casual" wizard or a single "row updater". A wizard which reports that no update is necessary stays marked as done, as it would otherwise vanish from the list of executed wizards without being executable again.

Methods

executeWizard()

Execute a single update wizard

public executeWizard(string $identifier, array $values) : FlashMessageQueue

Parameters

$identifier : string
$values : array

Tags

throws
RuntimeException

Return values

FlashMessageQueue

getNonRepeatableUpgradeWizards()

public getNonRepeatableUpgradeWizards() : array

Return values

array

getUpgradeWizardIdentifiers()

public getUpgradeWizardIdentifiers() : array

Return values

array

getUpgradeWizardsList()

Get list of registered upgrade wizards not marked done.

public getUpgradeWizardsList() : array

Return values

array —

List of upgrade wizards in correct order with detail information

getWizardInformationByIdentifier()

public getWizardInformationByIdentifier(string $identifier) : array

Parameters

$identifier : string

Return values

array

getWizardUserInput()

Execute the "get user input" step of a wizard

public getWizardUserInput(string $identifier) : array

Parameters

$identifier : string

Tags

throws
RuntimeException

Return values

array

isWizardDone()

Checks if this wizard has been "done" before

public isWizardDone(string $identifier) : bool

Parameters

$identifier : string

Tags

throws
RuntimeException

Return values

bool —

TRUE if wizard has been done before, FALSE otherwise

listOfRowUpdatersDone()

public listOfRowUpdatersDone() : array

Tags

throws
RuntimeException

Return values

array —

List of row updaters marked as done in registry

listOfWizardsDone()

public listOfWizardsDone() : array

Return values

array —

List of wizards marked as done in registry

markWizardUndone()

Mark one wizard as undone. This can be a "casual" wizard or a single "row updater". A wizard which reports that no update is necessary stays marked as done, as it would otherwise vanish from the list of executed wizards without being executable again.

public markWizardUndone(string $identifier) : bool

Parameters

$identifier : string

Wizard or RowUpdater identifier

Tags

throws
RuntimeException

Return values

bool —

True if wizard has been marked as undone

On this page