ShortcutRecordsMigration implements UpgradeWizardInterface
This class is only meant to be used within EXT:install and is not part of the TYPO3 Core API.
Table of Contents
Interfaces
- UpgradeWizardInterface
- Interface UpgradeWizardInterface
Properties
- $routes : iterable<string|int, mixed>|null
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?
- columnsExistInTable() : bool
- getConnectionPool() : ConnectionPool
- getPreparedQueryBuilder() : QueryBuilder
- getRecordsToUpdate() : array<string|int, mixed>
- getRouteIdentifierForModuleName() : string
- hasRecordsToUpdate() : bool
Properties
$routes
protected
iterable<string|int, mixed>|null
$routes
= null
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.
Return values
boolcolumnsExistInTable()
protected
columnsExistInTable() : bool
Return values
boolgetConnectionPool()
protected
getConnectionPool() : ConnectionPool
Return values
ConnectionPoolgetPreparedQueryBuilder()
protected
getPreparedQueryBuilder() : QueryBuilder
Return values
QueryBuildergetRecordsToUpdate()
protected
getRecordsToUpdate() : array<string|int, mixed>
Return values
array<string|int, mixed>getRouteIdentifierForModuleName()
protected
getRouteIdentifierForModuleName(string $moduleName) : string
Parameters
- $moduleName : string
Return values
stringhasRecordsToUpdate()
protected
hasRecordsToUpdate() : bool