UpgradeWizardsService

Service class helping managing 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
addMissingTablesAndFields()  : array<string|int, mixed>
Add missing tables, indexes and fields to DB.
executeWizard()  : FlashMessageQueue
Execute a single update wizard
getBlockingDatabaseAdds()  : array<string|int, mixed>
Get a list of tables, single columns and indexes to add.
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
isDatabaseCharsetUtf8()  : bool
True if DB main charset on mysql is utf8
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".
setDatabaseCharsetUtf8()  : mixed
Set default connection MySQL database charset to utf8.
assertIdentifierIsValid()  : void
Validate identifier exists in upgrade wizard list

Methods

addMissingTablesAndFields()

Add missing tables, indexes and fields to DB.

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

getBlockingDatabaseAdds()

Get a list of tables, single columns and indexes to add.

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

Array with possible keys "tables", "columns", "indexes"

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>

isDatabaseCharsetUtf8()

True if DB main charset on mysql is utf8

public isDatabaseCharsetUtf8() : bool
Return values
bool —

True if charset is ok

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(string $identifier) : void

Writes the info in LocalConfiguration.php

Parameters
$identifier : string
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

setDatabaseCharsetUtf8()

Set default connection MySQL database charset to utf8.

public setDatabaseCharsetUtf8() : mixed

Should be called only if default database connection is actually MySQL

assertIdentifierIsValid()

Validate identifier exists in upgrade wizard list

protected assertIdentifierIsValid(string $identifier) : void
Parameters
$identifier : string
Tags
throws
RuntimeException 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results