AbstractUpdate Class Reference

Inheritance diagram for AbstractUpdate:

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 ( &  $description )

abstract

Checks whether updates are required.

Parameters

string

&$description

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

References AbstractUpdate\getDatabaseConnection().

getDatabaseConnection ( )

protected

Returns

Definition at line 225 of file AbstractUpdate.php.

References $GLOBALS.

Referenced by BackendUserStartModuleUpdate\checkForUpdate(), FileListIsStartModuleUpdate\checkForUpdate(), MigrateMediaToAssetsForTextMediaCe\checkForUpdate(), FilesReplacePermissionUpdate\checkForUpdate(), MigrateShortcutUrlsAgainUpdate\checkForUpdate(), ContentTypesToTextMediaUpdate\checkForUpdate(), WorkspacesNotificationSettingsUpdate\checkForUpdate(), LanguageIsoCodeUpdate\checkForUpdate(), TableFlexFormToTtContentFieldsUpdate\checkForUpdate(), ProcessedFileChecksumUpdate\checkForUpdate(), OpenidExtractionUpdate\checkForUpdate(), MediaceExtractionUpdate\checkForUpdate(), AbstractUpdate\checkIfTableExists(), RteAcronymButtonRenamedToAbbreviation\getPagesWithDeprecatedRteProperties(), DeprecatedRteProperties\getPagesWithDeprecatedRteProperties(), FilesReplacePermissionUpdate\getRecordsFromTable(), PageShortcutParentUpdate\getUpdatablePages(), MigrateShortcutUrlsAgainUpdate\performUpdate(), BackendUserStartModuleUpdate\performUpdate(), FileListIsStartModuleUpdate\performUpdate(), LanguageIsoCodeUpdate\performUpdate(), ProcessedFileChecksumUpdate\performUpdate(), TableFlexFormToTtContentFieldsUpdate\performUpdate(), MigrateMediaToAssetsForTextMediaCe\performUpdate(), PageShortcutParentUpdate\performUpdate(), ContentTypesToTextMediaUpdate\performUpdate(), FilesReplacePermissionUpdate\performUpdate(), WorkspacesNotificationSettingsUpdate\performUpdate(), FinalDatabaseSchemaUpdate\performUpdate(), InitialDatabaseSchemaUpdate\performUpdate(), RteAcronymButtonRenamedToAbbreviation\updatePages(), and DeprecatedRteProperties\updatePages().

getIdentifier

(

)

Returns the identifier of this class

Returns

string The identifier of this update wizard

Definition at line 92 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 67 of file AbstractUpdate.php.

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

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 BackendUserStartModuleUpdate\checkForUpdate(), FileListIsStartModuleUpdate\checkForUpdate(), MigrateMediaToAssetsForTextMediaCe\checkForUpdate(), MigrateShortcutUrlsAgainUpdate\checkForUpdate(), FilesReplacePermissionUpdate\checkForUpdate(), WorkspacesNotificationSettingsUpdate\checkForUpdate(), ContentTypesToTextMediaUpdate\checkForUpdate(), RteAcronymButtonRenamedToAbbreviation\checkForUpdate(), TableFlexFormToTtContentFieldsUpdate\checkForUpdate(), LanguageIsoCodeUpdate\checkForUpdate(), PageShortcutParentUpdate\checkForUpdate(), ProcessedFileChecksumUpdate\checkForUpdate(), OpenidExtractionUpdate\checkForUpdate(), MediaceExtractionUpdate\checkForUpdate(), Compatibility6ExtractionUpdate\checkForUpdate(), and DeprecatedRteProperties\checkForUpdate().

markWizardAsDone (   $confValue = 1 )

protected

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

Writes the info in LocalConfiguration.php

Parameters

mixed

$confValue

The configuration is set to this value

Returns

void

Definition at line 198 of file AbstractUpdate.php.

References GeneralUtility\makeInstance().

Referenced by MigrateMediaToAssetsForTextMediaCe\checkForUpdate(), WorkspacesNotificationSettingsUpdate\checkForUpdate(), BackendUserStartModuleUpdate\performUpdate(), MigrateShortcutUrlsAgainUpdate\performUpdate(), FileListIsStartModuleUpdate\performUpdate(), LanguageIsoCodeUpdate\performUpdate(), ProcessedFileChecksumUpdate\performUpdate(), TableFlexFormToTtContentFieldsUpdate\performUpdate(), MigrateMediaToAssetsForTextMediaCe\performUpdate(), PageShortcutParentUpdate\performUpdate(), ContentTypesToTextMediaUpdate\performUpdate(), FilesReplacePermissionUpdate\performUpdate(), WorkspacesNotificationSettingsUpdate\performUpdate(), RteAcronymButtonRenamedToAbbreviation\performUpdate(), MediaceExtractionUpdate\performUpdate(), OpenidExtractionUpdate\performUpdate(), Compatibility6ExtractionUpdate\performUpdate(), and DeprecatedRteProperties\performUpdate().

performUpdate ( array &  $dbQueries, &  $customMessages  )

abstract

Performs the accordant updates.

Parameters

array	&$dbQueries	Queries done in this update
mixed	&$customMessages	Custom messages

Returns

bool Whether everything went smoothly or not

setIdentifier

(

$identifier

)

Sets the identifier attribute

Parameters

string

$identifier

The identifier of this update wizard

Returns

void

Definition at line 103 of file AbstractUpdate.php.

References AbstractUpdate\$identifier.

setTitle

(

$title

)

Sets the title attribute

Parameters

string

$title

The title of this update wizard

Returns

void

Definition at line 82 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 132 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 116 of file AbstractUpdate.php.

References AbstractUpdate\checkForUpdate().

Member Data Documentation

$identifier

protected

Definition at line 38 of file AbstractUpdate.php.

Referenced by AbstractUpdate\getIdentifier(), AbstractUpdate\getTitle(), and AbstractUpdate\setIdentifier().

$pObj

Definition at line 45 of file AbstractUpdate.php.

$title

protected

Definition at line 31 of file AbstractUpdate.php.

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

$userInput

Definition at line 52 of file AbstractUpdate.php.

$versionNumber

Definition at line 60 of file AbstractUpdate.php.