‪TYPO3CMS  9.5
Public Member Functions | List of all members
TYPO3\CMS\Install\Updates\UpgradeWizardInterface Interface Reference
Inheritance diagram for TYPO3\CMS\Install\Updates\UpgradeWizardInterface:
TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate TYPO3\CMS\Install\Updates\AbstractDownloadExtensionUpdate TYPO3\CMS\Install\Updates\AbstractUpdate TYPO3\CMS\Install\Updates\Argon2iPasswordHashes TYPO3\CMS\Install\Updates\BackendLayoutIconUpdateWizard TYPO3\CMS\Install\Updates\BackendUserConfigurationUpdate TYPO3\CMS\Install\Updates\BackendUserStartModuleUpdate TYPO3\CMS\Install\Updates\BulletContentElementUpdate TYPO3\CMS\Install\Updates\CommandLineBackendUserRemovalUpdate TYPO3\CMS\Install\Updates\DatabaseRowsUpdateWizard TYPO3\CMS\Install\Updates\ExtensionManagerTables TYPO3\CMS\Install\Updates\FileReferenceUpdate TYPO3\CMS\Install\Updates\FillTranslationSourceField TYPO3\CMS\Install\Updates\FrontendUserImageUpdateWizard TYPO3\CMS\Install\Updates\LanguageSortingUpdate TYPO3\CMS\Install\Updates\MigrateFeSessionDataUpdate TYPO3\CMS\Install\Updates\MigrateFscStaticTemplateUpdate TYPO3\CMS\Install\Updates\MigratePagesLanguageOverlayBeGroupsAccessRights TYPO3\CMS\Install\Updates\MigratePagesLanguageOverlayUpdate TYPO3\CMS\Install\Updates\MigrateUrlTypesInPagesUpdate TYPO3\CMS\Install\Updates\PopulatePageSlugs TYPO3\CMS\Install\Updates\SectionFrameToFrameClassUpdate TYPO3\CMS\Install\Updates\SeparateSysHistoryFromSysLogUpdate TYPO3\CMS\Install\Updates\SplitMenusUpdate TYPO3\CMS\Install\Updates\StartModuleUpdate TYPO3\CMS\Install\Updates\SvgFilesSanitization TYPO3\CMS\Install\Updates\UploadContentElementUpdate TYPO3\CMS\Install\Updates\WizardDoneToRegistry

Public Member Functions

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

Detailed Description

Interface UpgradeWizardInterface

Definition at line 21 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\AbstractUpdate, TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate, TYPO3\CMS\Install\Updates\FrontendUserImageUpdateWizard, TYPO3\CMS\Install\Updates\BackendLayoutIconUpdateWizard, TYPO3\CMS\Install\Updates\DatabaseRowsUpdateWizard, TYPO3\CMS\Install\Updates\RedirectsExtensionUpdate, TYPO3\CMS\Install\Updates\CommandLineBackendUserRemovalUpdate, TYPO3\CMS\Install\Updates\SeparateSysHistoryFromSysLogUpdate, TYPO3\CMS\Install\Updates\Argon2iPasswordHashes, TYPO3\CMS\Install\Updates\MigrateUrlTypesInPagesUpdate, TYPO3\CMS\Install\Updates\SvgFilesSanitization, TYPO3\CMS\Install\Updates\MigratePagesLanguageOverlayUpdate, TYPO3\CMS\Install\Updates\BackendUserConfigurationUpdate, TYPO3\CMS\Install\Updates\PopulatePageSlugs, TYPO3\CMS\Install\Updates\BackendUserStartModuleUpdate, TYPO3\CMS\Install\Updates\MigrateFscStaticTemplateUpdate, TYPO3\CMS\Install\Updates\ExtensionManagerTables, TYPO3\CMS\Install\Updates\MigrateFeSessionDataUpdate, TYPO3\CMS\Install\Updates\StartModuleUpdate, TYPO3\CMS\Install\Updates\SectionFrameToFrameClassUpdate, TYPO3\CMS\Install\Updates\SplitMenusUpdate, TYPO3\CMS\Install\Updates\FileReferenceUpdate, TYPO3\CMS\Install\Updates\LanguageSortingUpdate, TYPO3\CMS\Install\Updates\WizardDoneToRegistry, TYPO3\CMS\Install\Updates\BulletContentElementUpdate, TYPO3\CMS\Install\Updates\FillTranslationSourceField, TYPO3\CMS\Install\Updates\UploadContentElementUpdate, TYPO3\CMS\Install\Updates\AbstractDownloadExtensionUpdate, and TYPO3\CMS\Install\Updates\MigratePagesLanguageOverlayBeGroupsAccessRights.

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\AbstractUpdate, TYPO3\CMS\Install\Updates\MigratePagesLanguageOverlayBeGroupsAccessRights, TYPO3\CMS\Install\Updates\Compatibility7ExtractionUpdate, TYPO3\CMS\Install\Updates\FrontendUserImageUpdateWizard, TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate, TYPO3\CMS\Install\Updates\BackendLayoutIconUpdateWizard, TYPO3\CMS\Install\Updates\FormLegacyExtractionUpdate, TYPO3\CMS\Install\Updates\RedirectExtractionUpdate, TYPO3\CMS\Install\Updates\AdminPanelInstall, TYPO3\CMS\Install\Updates\RedirectsExtensionUpdate, TYPO3\CMS\Install\Updates\DatabaseRowsUpdateWizard, TYPO3\CMS\Install\Updates\FuncExtractionUpdate, TYPO3\CMS\Install\Updates\RteHtmlAreaExtractionUpdate, TYPO3\CMS\Install\Updates\Typo3DbExtractionUpdate, TYPO3\CMS\Install\Updates\SvgFilesSanitization, TYPO3\CMS\Install\Updates\CommandLineBackendUserRemovalUpdate, TYPO3\CMS\Install\Updates\Argon2iPasswordHashes, TYPO3\CMS\Install\Updates\PopulatePageSlugs, TYPO3\CMS\Install\Updates\SeparateSysHistoryFromSysLogUpdate, TYPO3\CMS\Install\Updates\MigratePagesLanguageOverlayUpdate, TYPO3\CMS\Install\Updates\FileReferenceUpdate, TYPO3\CMS\Install\Updates\ExtensionManagerTables, TYPO3\CMS\Install\Updates\MigrateUrlTypesInPagesUpdate, TYPO3\CMS\Install\Updates\BackendUserConfigurationUpdate, TYPO3\CMS\Install\Updates\LanguageSortingUpdate, TYPO3\CMS\Install\Updates\MigrateFeSessionDataUpdate, TYPO3\CMS\Install\Updates\WizardDoneToRegistry, TYPO3\CMS\Install\Updates\BackendUserStartModuleUpdate, TYPO3\CMS\Install\Updates\BulletContentElementUpdate, TYPO3\CMS\Install\Updates\FillTranslationSourceField, TYPO3\CMS\Install\Updates\MigrateFscStaticTemplateUpdate, TYPO3\CMS\Install\Updates\SectionFrameToFrameClassUpdate, TYPO3\CMS\Install\Updates\SplitMenusUpdate, TYPO3\CMS\Install\Updates\StartModuleUpdate, and TYPO3\CMS\Install\Updates\UploadContentElementUpdate.

◆ 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\AbstractUpdate, TYPO3\CMS\Install\Updates\FrontendUserImageUpdateWizard, TYPO3\CMS\Install\Updates\Compatibility7ExtractionUpdate, TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate, TYPO3\CMS\Install\Updates\BackendLayoutIconUpdateWizard, TYPO3\CMS\Install\Updates\FormLegacyExtractionUpdate, TYPO3\CMS\Install\Updates\RedirectExtractionUpdate, TYPO3\CMS\Install\Updates\DatabaseRowsUpdateWizard, TYPO3\CMS\Install\Updates\AdminPanelInstall, TYPO3\CMS\Install\Updates\RedirectsExtensionUpdate, TYPO3\CMS\Install\Updates\FuncExtractionUpdate, TYPO3\CMS\Install\Updates\RteHtmlAreaExtractionUpdate, TYPO3\CMS\Install\Updates\Typo3DbExtractionUpdate, TYPO3\CMS\Install\Updates\SvgFilesSanitization, TYPO3\CMS\Install\Updates\CommandLineBackendUserRemovalUpdate, TYPO3\CMS\Install\Updates\Argon2iPasswordHashes, TYPO3\CMS\Install\Updates\PopulatePageSlugs, TYPO3\CMS\Install\Updates\SeparateSysHistoryFromSysLogUpdate, TYPO3\CMS\Install\Updates\MigratePagesLanguageOverlayUpdate, TYPO3\CMS\Install\Updates\FileReferenceUpdate, TYPO3\CMS\Install\Updates\ExtensionManagerTables, TYPO3\CMS\Install\Updates\MigrateUrlTypesInPagesUpdate, TYPO3\CMS\Install\Updates\BackendUserConfigurationUpdate, TYPO3\CMS\Install\Updates\LanguageSortingUpdate, TYPO3\CMS\Install\Updates\MigrateFeSessionDataUpdate, TYPO3\CMS\Install\Updates\WizardDoneToRegistry, TYPO3\CMS\Install\Updates\BackendUserStartModuleUpdate, TYPO3\CMS\Install\Updates\BulletContentElementUpdate, TYPO3\CMS\Install\Updates\FillTranslationSourceField, TYPO3\CMS\Install\Updates\MigrateFscStaticTemplateUpdate, TYPO3\CMS\Install\Updates\MigratePagesLanguageOverlayBeGroupsAccessRights, TYPO3\CMS\Install\Updates\SectionFrameToFrameClassUpdate, TYPO3\CMS\Install\Updates\SplitMenusUpdate, TYPO3\CMS\Install\Updates\StartModuleUpdate, and TYPO3\CMS\Install\Updates\UploadContentElementUpdate.

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\Install\Updates\AbstractUpdate, TYPO3\CMS\Install\Updates\RedirectsExtensionUpdate, TYPO3\CMS\Install\Updates\RedirectExtractionUpdate, TYPO3\CMS\Install\Updates\Compatibility7ExtractionUpdate, TYPO3\CMS\Install\Updates\FormLegacyExtractionUpdate, TYPO3\CMS\Install\Updates\FrontendUserImageUpdateWizard, TYPO3\CMS\Install\Updates\MigratePagesLanguageOverlayBeGroupsAccessRights, TYPO3\CMS\Install\Updates\SvgFilesSanitization, TYPO3\CMS\Install\Updates\DatabaseRowsUpdateWizard, TYPO3\CMS\Install\Updates\BackendLayoutIconUpdateWizard, TYPO3\CMS\Install\Updates\FuncExtractionUpdate, TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate, TYPO3\CMS\Install\Updates\AdminPanelInstall, TYPO3\CMS\Install\Updates\RteHtmlAreaExtractionUpdate, TYPO3\CMS\Install\Updates\Typo3DbExtractionUpdate, TYPO3\CMS\Install\Updates\CommandLineBackendUserRemovalUpdate, TYPO3\CMS\Install\Updates\SeparateSysHistoryFromSysLogUpdate, TYPO3\CMS\Install\Updates\Argon2iPasswordHashes, TYPO3\CMS\Install\Updates\MigrateUrlTypesInPagesUpdate, TYPO3\CMS\Install\Updates\BackendUserConfigurationUpdate, TYPO3\CMS\Install\Updates\PopulatePageSlugs, TYPO3\CMS\Install\Updates\MigrateFscStaticTemplateUpdate, TYPO3\CMS\Install\Updates\BackendUserStartModuleUpdate, TYPO3\CMS\Install\Updates\ExtensionManagerTables, TYPO3\CMS\Install\Updates\MigrateFeSessionDataUpdate, TYPO3\CMS\Install\Updates\SectionFrameToFrameClassUpdate, TYPO3\CMS\Install\Updates\StartModuleUpdate, TYPO3\CMS\Install\Updates\SplitMenusUpdate, TYPO3\CMS\Install\Updates\MigratePagesLanguageOverlayUpdate, TYPO3\CMS\Install\Updates\FileReferenceUpdate, TYPO3\CMS\Install\Updates\LanguageSortingUpdate, TYPO3\CMS\Install\Updates\WizardDoneToRegistry, TYPO3\CMS\Install\Updates\BulletContentElementUpdate, TYPO3\CMS\Install\Updates\FillTranslationSourceField, and TYPO3\CMS\Install\Updates\UploadContentElementUpdate.

◆ getTitle()

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

Return the speaking name of this wizard

Returns
‪string

Implemented in TYPO3\CMS\Install\Updates\FrontendUserImageUpdateWizard, TYPO3\CMS\Install\Updates\Compatibility7ExtractionUpdate, TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate, TYPO3\CMS\Install\Updates\BackendLayoutIconUpdateWizard, TYPO3\CMS\Install\Updates\FormLegacyExtractionUpdate, TYPO3\CMS\Install\Updates\RedirectExtractionUpdate, TYPO3\CMS\Install\Updates\AdminPanelInstall, TYPO3\CMS\Install\Updates\RedirectsExtensionUpdate, TYPO3\CMS\Install\Updates\DatabaseRowsUpdateWizard, TYPO3\CMS\Install\Updates\FuncExtractionUpdate, TYPO3\CMS\Install\Updates\RteHtmlAreaExtractionUpdate, TYPO3\CMS\Install\Updates\Typo3DbExtractionUpdate, TYPO3\CMS\Install\Updates\SvgFilesSanitization, TYPO3\CMS\Install\Updates\AbstractUpdate, TYPO3\CMS\Install\Updates\CommandLineBackendUserRemovalUpdate, TYPO3\CMS\Install\Updates\Argon2iPasswordHashes, TYPO3\CMS\Install\Updates\PopulatePageSlugs, TYPO3\CMS\Install\Updates\SeparateSysHistoryFromSysLogUpdate, TYPO3\CMS\Install\Updates\MigratePagesLanguageOverlayUpdate, TYPO3\CMS\Install\Updates\FileReferenceUpdate, TYPO3\CMS\Install\Updates\ExtensionManagerTables, TYPO3\CMS\Install\Updates\MigrateUrlTypesInPagesUpdate, TYPO3\CMS\Install\Updates\BackendUserConfigurationUpdate, TYPO3\CMS\Install\Updates\LanguageSortingUpdate, TYPO3\CMS\Install\Updates\MigrateFeSessionDataUpdate, TYPO3\CMS\Install\Updates\WizardDoneToRegistry, TYPO3\CMS\Install\Updates\BackendUserStartModuleUpdate, TYPO3\CMS\Install\Updates\BulletContentElementUpdate, TYPO3\CMS\Install\Updates\FillTranslationSourceField, TYPO3\CMS\Install\Updates\MigrateFscStaticTemplateUpdate, TYPO3\CMS\Install\Updates\SectionFrameToFrameClassUpdate, TYPO3\CMS\Install\Updates\SplitMenusUpdate, TYPO3\CMS\Install\Updates\StartModuleUpdate, TYPO3\CMS\Install\Updates\UploadContentElementUpdate, and TYPO3\CMS\Install\Updates\MigratePagesLanguageOverlayBeGroupsAccessRights.

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\Install\Updates\AbstractUpdate, TYPO3\CMS\Form\Hooks\FormFileExtensionUpdate, TYPO3\CMS\Install\Updates\Compatibility7ExtractionUpdate, TYPO3\CMS\Install\Updates\FrontendUserImageUpdateWizard, TYPO3\CMS\Install\Updates\MigratePagesLanguageOverlayBeGroupsAccessRights, TYPO3\CMS\Install\Updates\DatabaseRowsUpdateWizard, TYPO3\CMS\Install\Updates\BackendLayoutIconUpdateWizard, TYPO3\CMS\Install\Updates\RedirectExtractionUpdate, TYPO3\CMS\Install\Updates\FormLegacyExtractionUpdate, TYPO3\CMS\Install\Updates\RedirectsExtensionUpdate, TYPO3\CMS\Install\Updates\FuncExtractionUpdate, TYPO3\CMS\Install\Updates\AdminPanelInstall, TYPO3\CMS\Install\Updates\RteHtmlAreaExtractionUpdate, TYPO3\CMS\Install\Updates\Typo3DbExtractionUpdate, TYPO3\CMS\Install\Updates\SvgFilesSanitization, TYPO3\CMS\Install\Updates\Argon2iPasswordHashes, TYPO3\CMS\Install\Updates\CommandLineBackendUserRemovalUpdate, TYPO3\CMS\Install\Updates\PopulatePageSlugs, TYPO3\CMS\Install\Updates\SeparateSysHistoryFromSysLogUpdate, TYPO3\CMS\Install\Updates\MigratePagesLanguageOverlayUpdate, TYPO3\CMS\Install\Updates\MigrateFeSessionDataUpdate, TYPO3\CMS\Install\Updates\MigrateUrlTypesInPagesUpdate, TYPO3\CMS\Install\Updates\BackendUserConfigurationUpdate, TYPO3\CMS\Install\Updates\ExtensionManagerTables, TYPO3\CMS\Install\Updates\FileReferenceUpdate, TYPO3\CMS\Install\Updates\LanguageSortingUpdate, TYPO3\CMS\Install\Updates\BackendUserStartModuleUpdate, TYPO3\CMS\Install\Updates\SectionFrameToFrameClassUpdate, TYPO3\CMS\Install\Updates\SplitMenusUpdate, TYPO3\CMS\Install\Updates\WizardDoneToRegistry, TYPO3\CMS\Install\Updates\StartModuleUpdate, TYPO3\CMS\Install\Updates\BulletContentElementUpdate, TYPO3\CMS\Install\Updates\FillTranslationSourceField, TYPO3\CMS\Install\Updates\MigrateFscStaticTemplateUpdate, and TYPO3\CMS\Install\Updates\UploadContentElementUpdate.