TYPO3\CMS\Install\Updates\UpgradeWizardInterface Interface Reference

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

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

Detailed Description

Interface UpgradeWizardInterface

Definition at line 23 of file UpgradeWizardInterface.php.

Member Function Documentation

executeUpdate()

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

(

)

Execute the update

Called when a wizard reports that an update is necessary

Implemented in TYPO3\CMS\Install\Updates\DatabaseRowsUpdateWizard, TYPO3\CMS\Extensionmanager\Updates\AbstractDownloadExtensionUpdate, TYPO3\CMS\Install\Updates\BackendGroupsExplicitAllowDenyMigration, TYPO3\CMS\Install\Updates\SysTemplateNoWorkspaceMigration, TYPO3\CMS\Install\Updates\IndexedSearchCTypeMigration, TYPO3\CMS\Install\Updates\BackendModulePermissionMigration, TYPO3\CMS\Install\Updates\MigrateSiteSettingsConfigUpdate, TYPO3\CMS\Install\Updates\PagesRecyclerDoktypeMigration, TYPO3\CMS\Install\Updates\SysLogSerializationUpdate, TYPO3\CMS\Install\Updates\SysFileCollectionIdentifierMigration, and TYPO3\CMS\Install\Updates\SysFileMountIdentifierMigration.

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

getDescription()

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

(

)

Return the description for this wizard

Implemented in TYPO3\CMS\Install\Updates\DatabaseRowsUpdateWizard, TYPO3\CMS\Extensionmanager\Updates\FeLoginModeExtractionUpdate, TYPO3\CMS\Install\Updates\MigrateSiteSettingsConfigUpdate, TYPO3\CMS\Install\Updates\IndexedSearchCTypeMigration, TYPO3\CMS\Install\Updates\BackendModulePermissionMigration, TYPO3\CMS\Install\Updates\BackendGroupsExplicitAllowDenyMigration, TYPO3\CMS\Install\Updates\PagesRecyclerDoktypeMigration, TYPO3\CMS\Install\Updates\SysLogSerializationUpdate, TYPO3\CMS\Install\Updates\SysTemplateNoWorkspaceMigration, TYPO3\CMS\Install\Updates\SysFileCollectionIdentifierMigration, and TYPO3\CMS\Install\Updates\SysFileMountIdentifierMigration.

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\DatabaseRowsUpdateWizard, TYPO3\CMS\Extensionmanager\Updates\FeLoginModeExtractionUpdate, TYPO3\CMS\Install\Updates\MigrateSiteSettingsConfigUpdate, TYPO3\CMS\Install\Updates\IndexedSearchCTypeMigration, TYPO3\CMS\Install\Updates\BackendModulePermissionMigration, TYPO3\CMS\Install\Updates\BackendGroupsExplicitAllowDenyMigration, TYPO3\CMS\Install\Updates\SysTemplateNoWorkspaceMigration, TYPO3\CMS\Install\Updates\PagesRecyclerDoktypeMigration, TYPO3\CMS\Install\Updates\SysLogSerializationUpdate, TYPO3\CMS\Install\Updates\SysFileCollectionIdentifierMigration, and TYPO3\CMS\Install\Updates\SysFileMountIdentifierMigration.

getTitle()

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

(

)

Return the speaking name of this wizard

Implemented in TYPO3\CMS\Install\Updates\DatabaseRowsUpdateWizard, TYPO3\CMS\Extensionmanager\Updates\FeLoginModeExtractionUpdate, TYPO3\CMS\Install\Updates\MigrateSiteSettingsConfigUpdate, TYPO3\CMS\Install\Updates\IndexedSearchCTypeMigration, TYPO3\CMS\Install\Updates\BackendModulePermissionMigration, TYPO3\CMS\Install\Updates\BackendGroupsExplicitAllowDenyMigration, TYPO3\CMS\Install\Updates\PagesRecyclerDoktypeMigration, TYPO3\CMS\Install\Updates\SysLogSerializationUpdate, TYPO3\CMS\Install\Updates\SysTemplateNoWorkspaceMigration, TYPO3\CMS\Install\Updates\SysFileCollectionIdentifierMigration, and TYPO3\CMS\Install\Updates\SysFileMountIdentifierMigration.

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

updateNecessary()

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.

Implemented in TYPO3\CMS\Install\Updates\DatabaseRowsUpdateWizard, TYPO3\CMS\Extensionmanager\Updates\FeLoginModeExtractionUpdate, TYPO3\CMS\Install\Updates\MigrateSiteSettingsConfigUpdate, TYPO3\CMS\Install\Updates\IndexedSearchCTypeMigration, TYPO3\CMS\Install\Updates\BackendGroupsExplicitAllowDenyMigration, TYPO3\CMS\Install\Updates\BackendModulePermissionMigration, TYPO3\CMS\Install\Updates\SysTemplateNoWorkspaceMigration, TYPO3\CMS\Install\Updates\PagesRecyclerDoktypeMigration, TYPO3\CMS\Install\Updates\SysLogSerializationUpdate, TYPO3\CMS\Install\Updates\SysFileCollectionIdentifierMigration, and TYPO3\CMS\Install\Updates\SysFileMountIdentifierMigration.

Referenced by TYPO3\CMS\Install\Command\UpgradeWizardListCommand\getWizard().