TYPO3 CMS  TYPO3_7-6
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Install\Updates\AbstractUpdate Class Reference
Inheritance diagram for TYPO3\CMS\Install\Updates\AbstractUpdate:
TYPO3\CMS\Install\Updates\AbstractDatabaseSchemaUpdate TYPO3\CMS\Install\Updates\AbstractDownloadExtensionUpdate TYPO3\CMS\Install\Updates\AccessRightParametersUpdate TYPO3\CMS\Install\Updates\BackendUserStartModuleUpdate TYPO3\CMS\Install\Updates\ContentTypesToTextMediaUpdate TYPO3\CMS\Install\Updates\ExtensionManagerTables TYPO3\CMS\Install\Updates\FileListInAccessModuleListUpdate TYPO3\CMS\Install\Updates\FileListIsStartModuleUpdate TYPO3\CMS\Install\Updates\FilesReplacePermissionUpdate TYPO3\CMS\Install\Updates\LanguageIsoCodeUpdate TYPO3\CMS\Install\Updates\MigrateMediaToAssetsForTextMediaCe TYPO3\CMS\Install\Updates\MigrateShortcutUrlsAgainUpdate TYPO3\CMS\Install\Updates\PageShortcutParentUpdate TYPO3\CMS\Install\Updates\ProcessedFileChecksumUpdate TYPO3\CMS\Install\Updates\TableFlexFormToTtContentFieldsUpdate TYPO3\CMS\Install\Updates\WorkspacesNotificationSettingsUpdate TYPO3\CMS\Rtehtmlarea\Hook\Install\DeprecatedRteProperties TYPO3\CMS\Rtehtmlarea\Hook\Install\RteAcronymButtonRenamedToAbbreviation

Public Member Functions

 getTitle ()
 
 setTitle ($title)
 
 getIdentifier ()
 
 setIdentifier ($identifier)
 
 shouldRenderWizard ()
 
 shouldRenderNextButton ()
 
 checkIfTableExists ($table)
 
 checkForUpdate (&$description)
 
 performUpdate (array &$dbQueries, &$customMessages)
 

Public Attributes

 $pObj
 
 $userInput
 
 $versionNumber
 

Protected Member Functions

 markWizardAsDone ($confValue=1)
 
 isWizardDone ()
 
 getDatabaseConnection ()
 

Protected Attributes

 $title
 
 $identifier
 

Detailed Description

Generic class that every update wizard class inherits from. Used by the update wizard in the install tool.

Definition at line 24 of file AbstractUpdate.php.

Member Function Documentation

◆ checkForUpdate()

TYPO3\CMS\Install\Updates\AbstractUpdate::checkForUpdate ( &  $description)
abstract

Checks whether updates are required.

Parameters
string&$descriptionThe description for the update
Returns
bool Whether an update is required (TRUE) or not (FALSE)

Referenced by TYPO3\CMS\Install\Updates\AbstractUpdate\checkIfTableExists(), TYPO3\CMS\Install\Updates\AbstractUpdate\shouldRenderNextButton(), and TYPO3\CMS\Install\Updates\AbstractUpdate\shouldRenderWizard().

◆ checkIfTableExists()

TYPO3\CMS\Install\Updates\AbstractUpdate::checkIfTableExists (   $table)

Check if given table exists

Parameters
string$table
Returns
bool

Definition at line 146 of file AbstractUpdate.php.

References TYPO3\CMS\Install\Updates\AbstractUpdate\checkForUpdate(), TYPO3\CMS\Install\Updates\AbstractUpdate\getDatabaseConnection(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), and TYPO3\CMS\Install\Updates\AbstractUpdate\performUpdate().

◆ getDatabaseConnection()

TYPO3\CMS\Install\Updates\AbstractUpdate::getDatabaseConnection ( )
protected
Returns

Definition at line 225 of file AbstractUpdate.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Install\Updates\BackendUserStartModuleUpdate\checkForUpdate(), TYPO3\CMS\Install\Updates\FileListIsStartModuleUpdate\checkForUpdate(), TYPO3\CMS\Install\Updates\MigrateMediaToAssetsForTextMediaCe\checkForUpdate(), TYPO3\CMS\Install\Updates\MigrateShortcutUrlsAgainUpdate\checkForUpdate(), TYPO3\CMS\Install\Updates\FilesReplacePermissionUpdate\checkForUpdate(), TYPO3\CMS\Install\Updates\WorkspacesNotificationSettingsUpdate\checkForUpdate(), TYPO3\CMS\Install\Updates\ContentTypesToTextMediaUpdate\checkForUpdate(), TYPO3\CMS\Install\Updates\LanguageIsoCodeUpdate\checkForUpdate(), TYPO3\CMS\Install\Updates\TableFlexFormToTtContentFieldsUpdate\checkForUpdate(), TYPO3\CMS\Install\Updates\ProcessedFileChecksumUpdate\checkForUpdate(), TYPO3\CMS\Install\Updates\FileListInAccessModuleListUpdate\checkForUpdate(), TYPO3\CMS\Install\Updates\OpenidExtractionUpdate\checkForUpdate(), TYPO3\CMS\Install\Updates\MediaceExtractionUpdate\checkForUpdate(), TYPO3\CMS\Install\Updates\ExtensionManagerTables\checkForUpdate(), TYPO3\CMS\Install\Updates\AbstractUpdate\checkIfTableExists(), TYPO3\CMS\Rtehtmlarea\Hook\Install\RteAcronymButtonRenamedToAbbreviation\getPagesWithDeprecatedRteProperties(), TYPO3\CMS\Rtehtmlarea\Hook\Install\DeprecatedRteProperties\getPagesWithDeprecatedRteProperties(), TYPO3\CMS\Install\Updates\FilesReplacePermissionUpdate\getRecordsFromTable(), TYPO3\CMS\Install\Updates\PageShortcutParentUpdate\getUpdatablePages(), TYPO3\CMS\Install\Updates\ExtensionManagerTables\hasError(), TYPO3\CMS\Install\Updates\MigrateShortcutUrlsAgainUpdate\performUpdate(), TYPO3\CMS\Install\Updates\BackendUserStartModuleUpdate\performUpdate(), TYPO3\CMS\Install\Updates\FileListIsStartModuleUpdate\performUpdate(), TYPO3\CMS\Install\Updates\LanguageIsoCodeUpdate\performUpdate(), TYPO3\CMS\Install\Updates\ProcessedFileChecksumUpdate\performUpdate(), TYPO3\CMS\Install\Updates\TableFlexFormToTtContentFieldsUpdate\performUpdate(), TYPO3\CMS\Install\Updates\MigrateMediaToAssetsForTextMediaCe\performUpdate(), TYPO3\CMS\Install\Updates\PageShortcutParentUpdate\performUpdate(), TYPO3\CMS\Install\Updates\ContentTypesToTextMediaUpdate\performUpdate(), TYPO3\CMS\Install\Updates\FileListInAccessModuleListUpdate\performUpdate(), TYPO3\CMS\Install\Updates\FilesReplacePermissionUpdate\performUpdate(), TYPO3\CMS\Install\Updates\WorkspacesNotificationSettingsUpdate\performUpdate(), TYPO3\CMS\Install\Updates\ExtensionManagerTables\performUpdate(), TYPO3\CMS\Install\Updates\FinalDatabaseSchemaUpdate\performUpdate(), TYPO3\CMS\Install\Updates\InitialDatabaseSchemaUpdate\performUpdate(), TYPO3\CMS\Rtehtmlarea\Hook\Install\RteAcronymButtonRenamedToAbbreviation\updatePages(), and TYPO3\CMS\Rtehtmlarea\Hook\Install\DeprecatedRteProperties\updatePages().

◆ getIdentifier()

TYPO3\CMS\Install\Updates\AbstractUpdate::getIdentifier ( )

Returns the identifier of this class

Returns
string The identifier of this update wizard

Definition at line 92 of file AbstractUpdate.php.

References TYPO3\CMS\Install\Updates\AbstractUpdate\$identifier.

Referenced by TYPO3\CMS\Install\Controller\Action\Tool\UpgradeWizard\getNextUpdateInstance().

◆ getTitle()

TYPO3\CMS\Install\Updates\AbstractUpdate::getTitle ( )

Returns the title attribute

Returns
string The title of this update wizard

Definition at line 67 of file AbstractUpdate.php.

References TYPO3\CMS\Install\Updates\AbstractUpdate\$identifier, and TYPO3\CMS\Install\Updates\AbstractUpdate\$title.

◆ isWizardDone()

TYPO3\CMS\Install\Updates\AbstractUpdate::isWizardDone ( )
protected

Checks if this wizard has been "done" before

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

Definition at line 209 of file AbstractUpdate.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Install\Updates\BackendUserStartModuleUpdate\checkForUpdate(), TYPO3\CMS\Install\Updates\FileListIsStartModuleUpdate\checkForUpdate(), TYPO3\CMS\Install\Updates\MigrateMediaToAssetsForTextMediaCe\checkForUpdate(), TYPO3\CMS\Install\Updates\MigrateShortcutUrlsAgainUpdate\checkForUpdate(), TYPO3\CMS\Install\Updates\FilesReplacePermissionUpdate\checkForUpdate(), TYPO3\CMS\Install\Updates\ContentTypesToTextMediaUpdate\checkForUpdate(), TYPO3\CMS\Install\Updates\WorkspacesNotificationSettingsUpdate\checkForUpdate(), TYPO3\CMS\Install\Updates\LanguageIsoCodeUpdate\checkForUpdate(), TYPO3\CMS\Rtehtmlarea\Hook\Install\RteAcronymButtonRenamedToAbbreviation\checkForUpdate(), TYPO3\CMS\Install\Updates\TableFlexFormToTtContentFieldsUpdate\checkForUpdate(), TYPO3\CMS\Install\Updates\PageShortcutParentUpdate\checkForUpdate(), TYPO3\CMS\Install\Updates\ProcessedFileChecksumUpdate\checkForUpdate(), TYPO3\CMS\Install\Updates\FileListInAccessModuleListUpdate\checkForUpdate(), TYPO3\CMS\Install\Updates\OpenidExtractionUpdate\checkForUpdate(), TYPO3\CMS\Install\Updates\Compatibility6ExtractionUpdate\checkForUpdate(), TYPO3\CMS\Install\Updates\MediaceExtractionUpdate\checkForUpdate(), and TYPO3\CMS\Rtehtmlarea\Hook\Install\DeprecatedRteProperties\checkForUpdate().

◆ markWizardAsDone()

TYPO3\CMS\Install\Updates\AbstractUpdate::markWizardAsDone (   $confValue = 1)
protected

Marks some wizard as being "seen" so that it not shown again.

Writes the info in LocalConfiguration.php

Parameters
mixed$confValueThe configuration is set to this value
Returns
void

Definition at line 198 of file AbstractUpdate.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Referenced by TYPO3\CMS\Install\Updates\MigrateMediaToAssetsForTextMediaCe\checkForUpdate(), TYPO3\CMS\Install\Updates\WorkspacesNotificationSettingsUpdate\checkForUpdate(), TYPO3\CMS\Install\Updates\BackendUserStartModuleUpdate\performUpdate(), TYPO3\CMS\Install\Updates\MigrateShortcutUrlsAgainUpdate\performUpdate(), TYPO3\CMS\Install\Updates\FileListIsStartModuleUpdate\performUpdate(), TYPO3\CMS\Install\Updates\LanguageIsoCodeUpdate\performUpdate(), TYPO3\CMS\Install\Updates\ProcessedFileChecksumUpdate\performUpdate(), TYPO3\CMS\Install\Updates\TableFlexFormToTtContentFieldsUpdate\performUpdate(), TYPO3\CMS\Install\Updates\MigrateMediaToAssetsForTextMediaCe\performUpdate(), TYPO3\CMS\Install\Updates\PageShortcutParentUpdate\performUpdate(), TYPO3\CMS\Install\Updates\FileListInAccessModuleListUpdate\performUpdate(), TYPO3\CMS\Install\Updates\ContentTypesToTextMediaUpdate\performUpdate(), TYPO3\CMS\Install\Updates\FilesReplacePermissionUpdate\performUpdate(), TYPO3\CMS\Install\Updates\WorkspacesNotificationSettingsUpdate\performUpdate(), TYPO3\CMS\Rtehtmlarea\Hook\Install\RteAcronymButtonRenamedToAbbreviation\performUpdate(), TYPO3\CMS\Install\Updates\MediaceExtractionUpdate\performUpdate(), TYPO3\CMS\Install\Updates\OpenidExtractionUpdate\performUpdate(), TYPO3\CMS\Install\Updates\Compatibility6ExtractionUpdate\performUpdate(), and TYPO3\CMS\Rtehtmlarea\Hook\Install\DeprecatedRteProperties\performUpdate().

◆ performUpdate()

TYPO3\CMS\Install\Updates\AbstractUpdate::performUpdate ( array &  $dbQueries,
&  $customMessages 
)
abstract

Performs the accordant updates.

Parameters
array&$dbQueriesQueries done in this update
mixed&$customMessagesCustom messages
Returns
bool Whether everything went smoothly or not

Referenced by TYPO3\CMS\Install\Updates\AbstractUpdate\checkIfTableExists().

◆ setIdentifier()

TYPO3\CMS\Install\Updates\AbstractUpdate::setIdentifier (   $identifier)

Sets the identifier attribute

Parameters
string$identifierThe identifier of this update wizard
Returns
void

Definition at line 103 of file AbstractUpdate.php.

References TYPO3\CMS\Install\Updates\AbstractUpdate\$identifier.

◆ setTitle()

TYPO3\CMS\Install\Updates\AbstractUpdate::setTitle (   $title)

Sets the title attribute

Parameters
string$titleThe title of this update wizard
Returns
void

Definition at line 82 of file AbstractUpdate.php.

References TYPO3\CMS\Install\Updates\AbstractUpdate\$title.

◆ shouldRenderNextButton()

TYPO3\CMS\Install\Updates\AbstractUpdate::shouldRenderNextButton ( )

Simple wrapper function that helps to check whether (if) this feature is cool if you want to tell the user that the update wizard is working fine, just as output (useful for the character set / utf8 wizard)

Returns
bool If the wizard should render the Next() button on the overview page
See also
checkForUpdate()

Definition at line 132 of file AbstractUpdate.php.

References TYPO3\CMS\Install\Updates\AbstractUpdate\checkForUpdate().

◆ shouldRenderWizard()

TYPO3\CMS\Install\Updates\AbstractUpdate::shouldRenderWizard ( )

Simple wrapper function that helps dealing with the compatibility layer that some update wizards don't have a second parameter thus, it evaluates everything already

Returns
bool If the wizard should be shown at all on the overview page
See also
checkForUpdate()

Definition at line 116 of file AbstractUpdate.php.

References TYPO3\CMS\Install\Updates\AbstractUpdate\checkForUpdate().

Member Data Documentation

◆ $identifier

TYPO3\CMS\Install\Updates\AbstractUpdate::$identifier
protected

Definition at line 38 of file AbstractUpdate.php.

Referenced by TYPO3\CMS\Install\Updates\AbstractUpdate\getIdentifier(), TYPO3\CMS\Install\Updates\AbstractUpdate\getTitle(), and TYPO3\CMS\Install\Updates\AbstractUpdate\setIdentifier().

◆ $pObj

TYPO3\CMS\Install\Updates\AbstractUpdate::$pObj

Definition at line 45 of file AbstractUpdate.php.

◆ $title

TYPO3\CMS\Install\Updates\AbstractUpdate::$title
protected

Definition at line 31 of file AbstractUpdate.php.

Referenced by TYPO3\CMS\Install\Updates\AbstractUpdate\getTitle(), and TYPO3\CMS\Install\Updates\AbstractUpdate\setTitle().

◆ $userInput

TYPO3\CMS\Install\Updates\AbstractUpdate::$userInput

Definition at line 52 of file AbstractUpdate.php.

◆ $versionNumber

TYPO3\CMS\Install\Updates\AbstractUpdate::$versionNumber

Definition at line 60 of file AbstractUpdate.php.