TYPO3CMS  8
 All Classes Namespaces Files Functions Variables Pages
AbstractUpdate Class Reference
Inheritance diagram for AbstractUpdate:
AbstractDatabaseSchemaUpdate AbstractDownloadExtensionUpdate AccessRightParametersUpdate BackendUserStartModuleUpdate ContentTypesToTextMediaUpdate DatabaseCharsetUpdate ExtensionManagerTables FileListIsStartModuleUpdate FilesReplacePermissionUpdate FrontendUserImageUpdateWizard LanguageIsoCodeUpdate MigrateMediaToAssetsForTextMediaCe MigrateShortcutUrlsAgainUpdate PageShortcutParentUpdate ProcessedFileChecksumUpdate TableFlexFormToTtContentFieldsUpdate WizardDoneToRegistry WorkspacesNotificationSettingsUpdate DeprecatedRteProperties 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 ()
 

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 27 of file AbstractUpdate.php.

Member Function Documentation

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 AbstractUpdate\shouldRenderNextButton(), and AbstractUpdate\shouldRenderWizard().

checkIfTableExists (   $table)

Check if given table exists

Parameters
string$table
Returns
bool

Definition at line 149 of file AbstractUpdate.php.

References GeneralUtility\makeInstance().

getIdentifier ( )

Returns the identifier of this class

Returns
string The identifier of this update wizard

Definition at line 95 of file AbstractUpdate.php.

References AbstractUpdate\$identifier.

Referenced by UpgradeWizard\getNextUpdateInstance().

getTitle ( )

Returns the title attribute

Returns
string The title of this update wizard

Definition at line 70 of file AbstractUpdate.php.

References AbstractUpdate\$identifier, and AbstractUpdate\$title.

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
setIdentifier (   $identifier)

Sets the identifier attribute

Parameters
string$identifierThe identifier of this update wizard
Returns
void

Definition at line 106 of file AbstractUpdate.php.

References AbstractUpdate\$identifier.

setTitle (   $title)

Sets the title attribute

Parameters
string$titleThe title of this update wizard
Returns
void

Definition at line 85 of file AbstractUpdate.php.

References AbstractUpdate\$title.

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 135 of file AbstractUpdate.php.

References AbstractUpdate\checkForUpdate().

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 119 of file AbstractUpdate.php.

References AbstractUpdate\checkForUpdate().

Member Data Documentation

$pObj

Definition at line 48 of file AbstractUpdate.php.

$title
protected

Definition at line 34 of file AbstractUpdate.php.

Referenced by AbstractUpdate\getTitle(), and AbstractUpdate\setTitle().

$userInput

Definition at line 55 of file AbstractUpdate.php.

$versionNumber

Definition at line 63 of file AbstractUpdate.php.