TYPO3\CMS\Install\Updates\UpgradeWizardInterface Interface Reference

Inheritance diagram for TYPO3\CMS\Install\Updates\UpgradeWizardInterface:

Public Member Functions
string	getIdentifier ()
string	getTitle ()
string	getDescription ()
bool	executeUpdate ()
bool	updateNecessary ()
string[]	getPrerequisites ()

Detailed Description

Interface UpgradeWizardInterface

Definition at line 23 of file UpgradeWizardInterface.php.

Member Function Documentation

executeUpdate()

bool TYPO3\CMS\Install\Updates\UpgradeWizardInterface::executeUpdate

(

)

Execute the update

Called when a wizard reports that an update is necessary

Returns

‪bool

Implemented in TYPO3\CMS\Install\Updates\DatabaseRowsUpdateWizard, TYPO3\CMS\FrontendLogin\Updates\MigrateFeloginPlugins, TYPO3\CMS\Install\Updates\SvgFilesSanitization, TYPO3\CMS\FrontendLogin\Updates\MigrateFeloginPluginsCtype, TYPO3\CMS\Install\Updates\SysLogChannel, TYPO3\CMS\Install\Updates\ShortcutRecordsMigration, TYPO3\CMS\Install\Updates\BackendUserLanguageMigration, and TYPO3\CMS\Install\Updates\AbstractDownloadExtensionUpdate.

Referenced by TYPO3\CMS\Install\Command\UpgradeWizardRunCommand\runSingleWizard().

getDescription()

string TYPO3\CMS\Install\Updates\UpgradeWizardInterface::getDescription

(

)

Return the description for this wizard

Returns

‪string

Implemented in TYPO3\CMS\Install\Updates\CollectionsExtractionUpdate, TYPO3\CMS\Install\Updates\DatabaseRowsUpdateWizard, TYPO3\CMS\FrontendLogin\Updates\MigrateFeloginPlugins, TYPO3\CMS\Install\Updates\FeeditExtractionUpdate, TYPO3\CMS\Install\Updates\SysActionExtractionUpdate, TYPO3\CMS\Install\Updates\TaskcenterExtractionUpdate, TYPO3\CMS\Install\Updates\SvgFilesSanitization, TYPO3\CMS\FrontendLogin\Updates\MigrateFeloginPluginsCtype, TYPO3\CMS\Install\Updates\SysLogChannel, TYPO3\CMS\Install\Updates\ShortcutRecordsMigration, and TYPO3\CMS\Install\Updates\BackendUserLanguageMigration.

getIdentifier()

string TYPO3\CMS\Install\Updates\UpgradeWizardInterface::getIdentifier

(

)

Return the identifier for this wizard This should be the same string as used in the ext_localconf class registration

Returns

‪string

Implemented in TYPO3\CMS\Install\Updates\DatabaseRowsUpdateWizard, TYPO3\CMS\Install\Updates\CollectionsExtractionUpdate, TYPO3\CMS\FrontendLogin\Updates\MigrateFeloginPlugins, TYPO3\CMS\Install\Updates\FeeditExtractionUpdate, TYPO3\CMS\Install\Updates\SysActionExtractionUpdate, TYPO3\CMS\Install\Updates\TaskcenterExtractionUpdate, TYPO3\CMS\Install\Updates\SvgFilesSanitization, TYPO3\CMS\Install\Updates\SysLogChannel, TYPO3\CMS\FrontendLogin\Updates\MigrateFeloginPluginsCtype, TYPO3\CMS\Install\Updates\ShortcutRecordsMigration, and TYPO3\CMS\Install\Updates\BackendUserLanguageMigration.

Referenced by TYPO3\CMS\Install\Command\UpgradeWizardRunCommand\runSingleWizard().

getPrerequisites()

string [] TYPO3\CMS\Install\Updates\UpgradeWizardInterface::getPrerequisites

(

)

Returns an array of class names of Prerequisite classes

This way a wizard can define dependencies like "database up-to-date" or "reference index updated"

Returns

‪string[]

Implemented in TYPO3\CMS\FrontendLogin\Updates\MigrateFeloginPlugins, TYPO3\CMS\Install\Updates\CollectionsExtractionUpdate, TYPO3\CMS\FrontendLogin\Updates\MigrateFeloginPluginsCtype, TYPO3\CMS\Install\Updates\DatabaseRowsUpdateWizard, TYPO3\CMS\Install\Updates\SvgFilesSanitization, TYPO3\CMS\Install\Updates\SysLogChannel, TYPO3\CMS\Install\Updates\SysActionExtractionUpdate, TYPO3\CMS\Install\Updates\TaskcenterExtractionUpdate, TYPO3\CMS\Install\Updates\FeeditExtractionUpdate, TYPO3\CMS\Install\Updates\ShortcutRecordsMigration, and TYPO3\CMS\Install\Updates\BackendUserLanguageMigration.

getTitle()

string TYPO3\CMS\Install\Updates\UpgradeWizardInterface::getTitle

(

)

Return the speaking name of this wizard

Returns

‪string

Implemented in TYPO3\CMS\Install\Updates\CollectionsExtractionUpdate, TYPO3\CMS\Install\Updates\DatabaseRowsUpdateWizard, TYPO3\CMS\FrontendLogin\Updates\MigrateFeloginPlugins, TYPO3\CMS\Install\Updates\FeeditExtractionUpdate, TYPO3\CMS\Install\Updates\SysActionExtractionUpdate, TYPO3\CMS\Install\Updates\TaskcenterExtractionUpdate, TYPO3\CMS\Install\Updates\SvgFilesSanitization, TYPO3\CMS\FrontendLogin\Updates\MigrateFeloginPluginsCtype, TYPO3\CMS\Install\Updates\SysLogChannel, TYPO3\CMS\Install\Updates\ShortcutRecordsMigration, and TYPO3\CMS\Install\Updates\BackendUserLanguageMigration.

Referenced by TYPO3\CMS\Install\Command\UpgradeWizardRunCommand\runSingleWizard().

updateNecessary()

bool TYPO3\CMS\Install\Updates\UpgradeWizardInterface::updateNecessary

(

)

Is an update necessary?

Is used to determine whether a wizard needs to be run. Check if data for migration exists.

Returns

‪bool

Implemented in TYPO3\CMS\FrontendLogin\Updates\MigrateFeloginPlugins, TYPO3\CMS\Install\Updates\DatabaseRowsUpdateWizard, TYPO3\CMS\Install\Updates\CollectionsExtractionUpdate, TYPO3\CMS\FrontendLogin\Updates\MigrateFeloginPluginsCtype, TYPO3\CMS\Install\Updates\SysLogChannel, TYPO3\CMS\Install\Updates\SysActionExtractionUpdate, TYPO3\CMS\Install\Updates\TaskcenterExtractionUpdate, TYPO3\CMS\Install\Updates\FeeditExtractionUpdate, TYPO3\CMS\Install\Updates\SvgFilesSanitization, TYPO3\CMS\Install\Updates\ShortcutRecordsMigration, and TYPO3\CMS\Install\Updates\BackendUserLanguageMigration.