UpgradeWizardInterface
Interface UpgradeWizardInterface
Table of Contents
Methods
- executeUpdate() : bool
- Execute the update
- getDescription() : string
- Return the description for this wizard
- getIdentifier() : string
- Return the identifier for this wizard This should be the same string as used in the ext_localconf class registration
- getPrerequisites() : array<string|int, string>
- Returns an array of class names of Prerequisite classes
- getTitle() : string
- Return the speaking name of this wizard
- updateNecessary() : bool
- Is an update necessary?
Methods
executeUpdate()
Execute the update
public
executeUpdate() : bool
Called when a wizard reports that an update is necessary
Return values
boolgetDescription()
Return the description for this wizard
public
getDescription() : string
Return values
stringgetIdentifier()
Return the identifier for this wizard This should be the same string as used in the ext_localconf class registration
public
getIdentifier() : string
Return values
stringgetPrerequisites()
Returns an array of class names of Prerequisite classes
public
getPrerequisites() : array<string|int, string>
This way a wizard can define dependencies like "database up-to-date" or "reference index updated"
Return values
array<string|int, string>getTitle()
Return the speaking name of this wizard
public
getTitle() : string
Return values
stringupdateNecessary()
Is an update necessary?
public
updateNecessary() : bool
Is used to determine whether a wizard needs to be run. Check if data for migration exists.