TYPO3\CMS\Install\Service\UpgradeWizardsService Class Reference

Public Member Functions
	__construct ()
array	listOfWizardsDone ()
array	listOfRowUpdatersDone ()
bool	markWizardUndone (string $identifier)
array	getBlockingDatabaseAdds ()
	addMissingTablesAndFields ()
bool	isDatabaseCharsetUtf8 ()
	setDatabaseCharsetUtf8 ()
array	getUpgradeWizardsList ()
	getWizardInformationByIdentifier (string $identifier)
array	getWizardUserInput (string $identifier)
FlashMessageQueue	executeWizard (string $identifier)
	markWizardAsDone (string $identifier)
bool	isWizardDone (string $identifier)

Protected Member Functions
	assertIdentifierIsValid (string $identifier)

Private Attributes
StreamOutput	$output

Detailed Description

Service class helping managing upgrade wizards

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

Definition at line 42 of file UpgradeWizardsService.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Install\Service\UpgradeWizardsService::__construct

(

)

Definition at line 48 of file UpgradeWizardsService.php.

Member Function Documentation

addMissingTablesAndFields()

TYPO3\CMS\Install\Service\UpgradeWizardsService::addMissingTablesAndFields

(

)

Add missing tables, indexes and fields to DB.

Definition at line 201 of file UpgradeWizardsService.php.

assertIdentifierIsValid()

TYPO3\CMS\Install\Service\UpgradeWizardsService::assertIdentifierIsValid ( string  $identifier )

protected

Validate identifier exists in upgrade wizard list

Parameters

string

$identifier

Exceptions

Definition at line 462 of file UpgradeWizardsService.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Install\Service\UpgradeWizardsService\executeWizard(), TYPO3\CMS\Install\Service\UpgradeWizardsService\getWizardUserInput(), TYPO3\CMS\Install\Service\UpgradeWizardsService\isWizardDone(), TYPO3\CMS\Install\Service\UpgradeWizardsService\markWizardAsDone(), and TYPO3\CMS\Install\Service\UpgradeWizardsService\markWizardUndone().

executeWizard()

FlashMessageQueue TYPO3\CMS\Install\Service\UpgradeWizardsService::executeWizard

(

string

$identifier

)

Execute a single update wizard

Parameters

string

$identifier

Returns

‪FlashMessageQueue

Exceptions

Definition at line 361 of file UpgradeWizardsService.php.

References $GLOBALS, TYPO3\CMS\Install\Service\UpgradeWizardsService\assertIdentifierIsValid(), TYPO3\CMS\Core\Messaging\AbstractMessage\ERROR, and TYPO3\CMS\Install\Service\UpgradeWizardsService\markWizardAsDone().

getBlockingDatabaseAdds()

array TYPO3\CMS\Install\Service\UpgradeWizardsService::getBlockingDatabaseAdds

(

)

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

Returns

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

Definition at line 152 of file UpgradeWizardsService.php.

getUpgradeWizardsList()

array TYPO3\CMS\Install\Service\UpgradeWizardsService::getUpgradeWizardsList

(

)

Get list of registered upgrade wizards not marked done.

Returns

‪array List of upgrade wizards in correct order with detail information

Definition at line 261 of file UpgradeWizardsService.php.

References $GLOBALS, TYPO3\CMS\Install\Service\UpgradeWizardsService\getWizardInformationByIdentifier(), and TYPO3\CMS\Install\Service\UpgradeWizardsService\isWizardDone().

getWizardInformationByIdentifier()

TYPO3\CMS\Install\Service\UpgradeWizardsService::getWizardInformationByIdentifier

(

string

$identifier

)

Definition at line 275 of file UpgradeWizardsService.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Install\Service\UpgradeWizardsService\getUpgradeWizardsList().

getWizardUserInput()

array TYPO3\CMS\Install\Service\UpgradeWizardsService::getWizardUserInput

(

string

$identifier

)

Execute the "get user input" step of a wizard

Parameters

string

$identifier

Returns

‪array

Exceptions

Definition at line 312 of file UpgradeWizardsService.php.

References $GLOBALS, and TYPO3\CMS\Install\Service\UpgradeWizardsService\assertIdentifierIsValid().

isDatabaseCharsetUtf8()

bool TYPO3\CMS\Install\Service\UpgradeWizardsService::isDatabaseCharsetUtf8

(

)

True if DB main charset on mysql is utf8

Returns

‪bool True if charset is ok

Definition at line 214 of file UpgradeWizardsService.php.

References TYPO3\CMS\Core\Database\ConnectionPool\DEFAULT_CONNECTION_NAME.

isWizardDone()

bool TYPO3\CMS\Install\Service\UpgradeWizardsService::isWizardDone

(

string

$identifier

)

Checks if this wizard has been "done" before

Parameters

string

$identifier

Returns

‪bool TRUE if wizard has been done before, FALSE otherwise

Exceptions

Definition at line 448 of file UpgradeWizardsService.php.

References $GLOBALS, and TYPO3\CMS\Install\Service\UpgradeWizardsService\assertIdentifierIsValid().

Referenced by TYPO3\CMS\Install\Service\UpgradeWizardsService\getUpgradeWizardsList().

listOfRowUpdatersDone()

array TYPO3\CMS\Install\Service\UpgradeWizardsService::listOfRowUpdatersDone

(

)

Returns

‪array List of row updaters marked as done in registry

Exceptions

Definition at line 81 of file UpgradeWizardsService.php.

Referenced by TYPO3\CMS\Install\Service\UpgradeWizardsService\markWizardUndone().

listOfWizardsDone()

array TYPO3\CMS\Install\Service\UpgradeWizardsService::listOfWizardsDone

(

)

Returns

‪array List of wizards marked as done in registry

Definition at line 60 of file UpgradeWizardsService.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Install\Service\UpgradeWizardsService\markWizardUndone().

markWizardAsDone()

TYPO3\CMS\Install\Service\UpgradeWizardsService::markWizardAsDone

(

string

$identifier

)

Marks some wizard as being "seen" so that it not shown again. Writes the info in LocalConfiguration.php

Parameters

string

$identifier

Exceptions

Definition at line 433 of file UpgradeWizardsService.php.

References $GLOBALS, and TYPO3\CMS\Install\Service\UpgradeWizardsService\assertIdentifierIsValid().

Referenced by TYPO3\CMS\Install\Service\UpgradeWizardsService\executeWizard().

markWizardUndone()

bool TYPO3\CMS\Install\Service\UpgradeWizardsService::markWizardUndone

(

string

$identifier

)

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

Parameters

string

$identifier

‪Wizard or RowUpdater identifier

Returns

‪bool True if wizard has been marked as undone

Exceptions

Definition at line 116 of file UpgradeWizardsService.php.

References TYPO3\CMS\Install\Service\UpgradeWizardsService\assertIdentifierIsValid(), TYPO3\CMS\Install\Service\UpgradeWizardsService\listOfRowUpdatersDone(), and TYPO3\CMS\Install\Service\UpgradeWizardsService\listOfWizardsDone().

setDatabaseCharsetUtf8()

TYPO3\CMS\Install\Service\UpgradeWizardsService::setDatabaseCharsetUtf8

(

)

Set default connection MySQL database charset to utf8. Should be called only if default database connection is actually MySQL

Definition at line 248 of file UpgradeWizardsService.php.

References TYPO3\CMS\Core\Database\ConnectionPool\DEFAULT_CONNECTION_NAME.

Member Data Documentation

$output

StreamOutput TYPO3\CMS\Install\Service\UpgradeWizardsService::$output

private

Definition at line 46 of file UpgradeWizardsService.php.