UpgradeWizardsService

FinalYes

Service class helps to manage upgrade wizards.

Internal

This class is only meant to be used within EXT:install and is not part of the TYPO3 Core API.

Table of Contents

Methods

__construct()  : mixed
executeWizard()  : FlashMessageQueue
Execute a single update wizard
getNonRepeatableUpgradeWizards()  : array<string|int, mixed>
getUpgradeWizard()  : UpgradeWizardInterface|null
Wrapper to catch \UnexpectedValueException for backwards compatibility reasons
getUpgradeWizardIdentifiers()  : array<string|int, mixed>
getUpgradeWizardsList()  : array<string|int, mixed>
Get list of registered upgrade wizards not marked done.
getWizardInformationByIdentifier()  : array<string|int, mixed>
getWizardUserInput()  : array<string|int, mixed>
Execute the "get user input" step of a wizard
isWizardDone()  : bool
Checks if this wizard has been "done" before
listOfRowUpdatersDone()  : array<string|int, mixed>
listOfWizardsDone()  : array<string|int, mixed>
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".

Methods

executeWizard()

Execute a single update wizard

public executeWizard(string $identifier, array<string|int, mixed> $values) : FlashMessageQueue
Parameters
$identifier : string
$values : array<string|int, mixed>
Tags
throws
RuntimeException
Return values
FlashMessageQueue

getNonRepeatableUpgradeWizards()

public getNonRepeatableUpgradeWizards() : array<string|int, mixed>
Return values
array<string|int, mixed>

getUpgradeWizardIdentifiers()

public getUpgradeWizardIdentifiers() : array<string|int, mixed>
Return values
array<string|int, mixed>

getUpgradeWizardsList()

Get list of registered upgrade wizards not marked done.

public getUpgradeWizardsList() : array<string|int, mixed>
Return values
array<string|int, mixed> —

List of upgrade wizards in correct order with detail information

getWizardInformationByIdentifier()

public getWizardInformationByIdentifier(string $identifier) : array<string|int, mixed>
Parameters
$identifier : string
Return values
array<string|int, mixed>

getWizardUserInput()

Execute the "get user input" step of a wizard

public getWizardUserInput(string $identifier) : array<string|int, mixed>
Parameters
$identifier : string
Tags
throws
RuntimeException
Return values
array<string|int, mixed>

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<string|int, mixed>
Tags
throws
RuntimeException
Return values
array<string|int, mixed> —

List of row updaters marked as done in registry

listOfWizardsDone()

public listOfWizardsDone() : array<string|int, mixed>
Return values
array<string|int, mixed> —

List of wizards marked as done in registry

markWizardAsDone()

Marks some wizard as being "seen" so that it not shown again.

public markWizardAsDone(UpgradeWizardInterface $upgradeWizard) : void

Writes the info in system/settings.php

Parameters
$upgradeWizard : UpgradeWizardInterface
Tags
throws
RuntimeException

markWizardUndone()

Mark one wizard as undone. This can be a "casual" wizard or a single "row updater".

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

        
    


            

                    

        

    

        

            
Search results