TYPO3\CMS\Install\Controller\UpgradeController Class Reference

Inheritance diagram for TYPO3\CMS\Install\Controller\UpgradeController:

Public Member Functions
	__construct (protected readonly PackageManager $packageManager, private readonly LateBootService $lateBootService, private readonly DatabaseUpgradeWizardsService $databaseUpgradeWizardsService, private readonly FormProtectionFactory $formProtectionFactory)
	cardsAction (ServerRequestInterface $request)
	coreUpdateActivateAction (ServerRequestInterface $request)
	coreUpdateCheckPreConditionsAction (ServerRequestInterface $request)
	coreUpdateDownloadAction (ServerRequestInterface $request)
	coreUpdateGetDataAction (ServerRequestInterface $request)
	coreUpdateIsUpdateAvailableAction ()
	coreUpdateMoveAction (ServerRequestInterface $request)
	coreUpdateUnpackAction (ServerRequestInterface $request)
	coreUpdateVerifyChecksumAction (ServerRequestInterface $request)
	extensionCompatTesterLoadedExtensionListAction (ServerRequestInterface $request)
	extensionCompatTesterLoadExtLocalconfAction (ServerRequestInterface $request)
	extensionCompatTesterLoadExtTablesAction (ServerRequestInterface $request)
	extensionCompatTesterUninstallExtensionAction (ServerRequestInterface $request)
	extensionScannerGetDataAction (ServerRequestInterface $request)
	extensionScannerFilesAction (ServerRequestInterface $request)
	extensionScannerMarkFullyScannedRestFilesAction (ServerRequestInterface $request)
	extensionScannerScanFileAction (ServerRequestInterface $request)
	tcaExtTablesCheckAction (ServerRequestInterface $request)
	tcaMigrationsCheckAction (ServerRequestInterface $request)
	upgradeDocsGetContentAction (ServerRequestInterface $request)
	upgradeDocsGetChangelogForVersionAction (ServerRequestInterface $request)
	upgradeDocsMarkReadAction (ServerRequestInterface $request)
	upgradeDocsUnmarkReadAction (ServerRequestInterface $request)
	upgradeWizardsBlockingDatabaseAddsAction ()
	upgradeWizardsBlockingDatabaseExecuteAction ()
	upgradeWizardsBlockingDatabaseCharsetFixAction ()
	upgradeWizardsBlockingDatabaseCharsetTestAction ()
	upgradeWizardsDoneUpgradesAction ()
	upgradeWizardsExecuteAction (ServerRequestInterface $request)
	upgradeWizardsInputAction (ServerRequestInterface $request)
	upgradeWizardsListAction ()
	upgradeWizardsMarkUndoneAction (ServerRequestInterface $request)
	upgradeWizardsGetDataAction (ServerRequestInterface $request)

Protected Member Functions
	coreUpdateInitialize ()
	coreUpdateGetVersionToHandle (ServerRequestInterface $request)
	extensionCompatTesterLoadExtLocalconfForExtension (PackageInterface $package)
	extensionCompatTesterLoadExtTablesForExtension (PackageInterface $package)
string[]	getDocumentationDirectories ()
	getDocumentationFiles (string $version)
string	extensionScannerGetLineFromFile (string $file, int $lineNumber)
	assertValidVersion (string $version)
‪Protected Member Functions inherited from ‪TYPO3\CMS\Install\Controller\AbstractController
	initializeView (ServerRequestInterface $request)

Protected Attributes
CoreUpdateService	$coreUpdateService
CoreVersionService	$coreVersionService
array	$matchers

Detailed Description

Upgrade controller

This class is a specific controller implementation and is not considered part of the Public TYPO3 API.

Definition at line 83 of file UpgradeController.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Install\Controller\UpgradeController::__construct	(	protected readonly PackageManager	$packageManager,
		private readonly LateBootService	$lateBootService,
		private readonly DatabaseUpgradeWizardsService	$databaseUpgradeWizardsService,
		private readonly FormProtectionFactory	$formProtectionFactory
	)

Definition at line 93 of file UpgradeController.php.

Member Function Documentation

assertValidVersion()

TYPO3\CMS\Install\Controller\UpgradeController::assertValidVersion ( string  $version )

protected

Asserts that the given version is valid

Exceptions

Definition at line 1342 of file UpgradeController.php.

Referenced by TYPO3\CMS\Install\Controller\UpgradeController\upgradeDocsGetChangelogForVersionAction().

cardsAction()

TYPO3\CMS\Install\Controller\UpgradeController::cardsAction

(

ServerRequestInterface

$request

)

Main "show the cards" view

Definition at line 191 of file UpgradeController.php.

References TYPO3\CMS\Install\Controller\AbstractController\initializeView().

coreUpdateActivateAction()

TYPO3\CMS\Install\Controller\UpgradeController::coreUpdateActivateAction

(

ServerRequestInterface

$request

)

Activate a new core

Definition at line 215 of file UpgradeController.php.

References TYPO3\CMS\Install\Controller\UpgradeController\coreUpdateInitialize().

coreUpdateCheckPreConditionsAction()

TYPO3\CMS\Install\Controller\UpgradeController::coreUpdateCheckPreConditionsAction

(

ServerRequestInterface

$request

)

Check if core update is possible

Definition at line 227 of file UpgradeController.php.

References TYPO3\CMS\Install\Controller\UpgradeController\coreUpdateInitialize(), and TYPO3\CMS\Core\Http\fromRequest.

coreUpdateDownloadAction()

TYPO3\CMS\Install\Controller\UpgradeController::coreUpdateDownloadAction

(

ServerRequestInterface

$request

)

Download new core

Definition at line 242 of file UpgradeController.php.

References TYPO3\CMS\Install\Controller\UpgradeController\coreUpdateInitialize().

coreUpdateGetDataAction()

TYPO3\CMS\Install\Controller\UpgradeController::coreUpdateGetDataAction

(

ServerRequestInterface

$request

)

Core Update Get Data Action

Definition at line 254 of file UpgradeController.php.

References TYPO3\CMS\Install\Controller\UpgradeController\$coreUpdateService, TYPO3\CMS\Install\Controller\UpgradeController\$coreVersionService, TYPO3\CMS\Core\Core\Environment\getPublicPath(), TYPO3\CMS\Install\Controller\AbstractController\initializeView(), TYPO3\CMS\Core\Core\Environment\isComposerMode(), and TYPO3\CMS\Install\Service\CoreUpdateService\isCoreUpdateEnabled().

coreUpdateGetVersionToHandle()

TYPO3\CMS\Install\Controller\UpgradeController::coreUpdateGetVersionToHandle ( ServerRequestInterface  $request )

protected

Find out which version upgrade should be handled. This may be different depending on whether development or regular release.

Exceptions

Definition at line 1210 of file UpgradeController.php.

coreUpdateInitialize()

TYPO3\CMS\Install\Controller\UpgradeController::coreUpdateInitialize ( )

protected

Initialize the core upgrade actions

Exceptions

Definition at line 1190 of file UpgradeController.php.

Referenced by TYPO3\CMS\Install\Controller\UpgradeController\coreUpdateActivateAction(), TYPO3\CMS\Install\Controller\UpgradeController\coreUpdateCheckPreConditionsAction(), TYPO3\CMS\Install\Controller\UpgradeController\coreUpdateDownloadAction(), TYPO3\CMS\Install\Controller\UpgradeController\coreUpdateIsUpdateAvailableAction(), TYPO3\CMS\Install\Controller\UpgradeController\coreUpdateMoveAction(), TYPO3\CMS\Install\Controller\UpgradeController\coreUpdateUnpackAction(), and TYPO3\CMS\Install\Controller\UpgradeController\coreUpdateVerifyChecksumAction().

coreUpdateIsUpdateAvailableAction()

TYPO3\CMS\Install\Controller\UpgradeController::coreUpdateIsUpdateAvailableAction

(

)

Check for new core

Definition at line 293 of file UpgradeController.php.

References TYPO3\CMS\Install\Controller\UpgradeController\coreUpdateInitialize().

coreUpdateMoveAction()

TYPO3\CMS\Install\Controller\UpgradeController::coreUpdateMoveAction

(

ServerRequestInterface

$request

)

Move core to new location

Definition at line 430 of file UpgradeController.php.

References TYPO3\CMS\Install\Controller\UpgradeController\coreUpdateInitialize().

coreUpdateUnpackAction()

TYPO3\CMS\Install\Controller\UpgradeController::coreUpdateUnpackAction

(

ServerRequestInterface

$request

)

Unpack a downloaded core

Definition at line 442 of file UpgradeController.php.

References TYPO3\CMS\Install\Controller\UpgradeController\coreUpdateInitialize().

coreUpdateVerifyChecksumAction()

TYPO3\CMS\Install\Controller\UpgradeController::coreUpdateVerifyChecksumAction

(

ServerRequestInterface

$request

)

Verify downloaded core checksum

Definition at line 454 of file UpgradeController.php.

References TYPO3\CMS\Install\Controller\UpgradeController\coreUpdateInitialize().

extensionCompatTesterLoadedExtensionListAction()

TYPO3\CMS\Install\Controller\UpgradeController::extensionCompatTesterLoadedExtensionListAction

(

ServerRequestInterface

$request

)

Get list of loaded extensions

Definition at line 466 of file UpgradeController.php.

References TYPO3\CMS\Install\Controller\AbstractController\initializeView().

extensionCompatTesterLoadExtLocalconfAction()

TYPO3\CMS\Install\Controller\UpgradeController::extensionCompatTesterLoadExtLocalconfAction

(

ServerRequestInterface

$request

)

Load all ext_localconf files in order until given extension name

Definition at line 491 of file UpgradeController.php.

References TYPO3\CMS\Install\Controller\UpgradeController\extensionCompatTesterLoadExtLocalconfForExtension().

extensionCompatTesterLoadExtLocalconfForExtension()

TYPO3\CMS\Install\Controller\UpgradeController::extensionCompatTesterLoadExtLocalconfForExtension ( PackageInterface  $package )

protected

Loads ext_localconf.php for a single extension. Method is a modified copy of the original bootstrap method.

Definition at line 1226 of file UpgradeController.php.

References TYPO3\CMS\Core\Package\PackageInterface\getPackagePath().

Referenced by TYPO3\CMS\Install\Controller\UpgradeController\extensionCompatTesterLoadExtLocalconfAction(), TYPO3\CMS\Install\Controller\UpgradeController\extensionCompatTesterLoadExtTablesAction(), and TYPO3\CMS\Install\Controller\UpgradeController\tcaExtTablesCheckAction().

extensionCompatTesterLoadExtTablesAction()

TYPO3\CMS\Install\Controller\UpgradeController::extensionCompatTesterLoadExtTablesAction

(

ServerRequestInterface

$request

)

Load all ext_localconf files in order until given extension name

Definition at line 518 of file UpgradeController.php.

References TYPO3\CMS\Install\Controller\UpgradeController\extensionCompatTesterLoadExtLocalconfForExtension(), and TYPO3\CMS\Install\Controller\UpgradeController\extensionCompatTesterLoadExtTablesForExtension().

extensionCompatTesterLoadExtTablesForExtension()

TYPO3\CMS\Install\Controller\UpgradeController::extensionCompatTesterLoadExtTablesForExtension ( PackageInterface  $package )

protected

Loads ext_tables.php for a single extension. Method is a modified copy of the original bootstrap method.

Definition at line 1238 of file UpgradeController.php.

References TYPO3\CMS\Core\Package\PackageInterface\getPackagePath().

Referenced by TYPO3\CMS\Install\Controller\UpgradeController\extensionCompatTesterLoadExtTablesAction().

extensionCompatTesterUninstallExtensionAction()

TYPO3\CMS\Install\Controller\UpgradeController::extensionCompatTesterUninstallExtensionAction

(

ServerRequestInterface

$request

)

Unload one extension

Exceptions

Definition at line 552 of file UpgradeController.php.

References TYPO3\CMS\Core\Utility\ExtensionManagementUtility\isLoaded(), and TYPO3\CMS\Core\Utility\ExtensionManagementUtility\unloadExtension().

extensionScannerFilesAction()

TYPO3\CMS\Install\Controller\UpgradeController::extensionScannerFilesAction

(

ServerRequestInterface

$request

)

Return a list of files of an extension

Definition at line 624 of file UpgradeController.php.

References $finder.

extensionScannerGetDataAction()

TYPO3\CMS\Install\Controller\UpgradeController::extensionScannerGetDataAction

(

ServerRequestInterface

$request

)

Create Extension Scanner Data action

Definition at line 590 of file UpgradeController.php.

References TYPO3\CMS\Install\Controller\AbstractController\initializeView().

extensionScannerGetLineFromFile()

string TYPO3\CMS\Install\Controller\UpgradeController::extensionScannerGetLineFromFile ( string  $file, int  $lineNumber  )

protected

Find a code line in a file

Parameters

string	$file	‪Absolute path to file
int	$lineNumber	‪Find this line in file

Returns

‪string Code line

Definition at line 1327 of file UpgradeController.php.

Referenced by TYPO3\CMS\Install\Controller\UpgradeController\extensionScannerScanFileAction().

extensionScannerMarkFullyScannedRestFilesAction()

TYPO3\CMS\Install\Controller\UpgradeController::extensionScannerMarkFullyScannedRestFilesAction

(

ServerRequestInterface

$request

)

Ajax controller, part of "extension scanner". Called at the end of "scan all" as last action. Gets a list of RST file hashes that matched, goes through all existing RST files, finds those marked as "FullyScanned" and marks those that did not had any matches as "you are not affected".

Definition at line 662 of file UpgradeController.php.

References $finder, and TYPO3\CMS\Core\Utility\ExtensionManagementUtility\extPath().

extensionScannerScanFileAction()

TYPO3\CMS\Install\Controller\UpgradeController::extensionScannerScanFileAction

(

ServerRequestInterface

$request

)

Scan a single extension file for breaking / deprecated core code usages

Definition at line 707 of file UpgradeController.php.

References $finder, TYPO3\CMS\Install\Controller\UpgradeController\$matchers, $parser, TYPO3\CMS\Install\Controller\UpgradeController\extensionScannerGetLineFromFile(), TYPO3\CMS\Core\Utility\ExtensionManagementUtility\extPath(), TYPO3\CMS\Core\Utility\StringUtility\getUniqueId(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

getDocumentationDirectories()

string [] TYPO3\CMS\Install\Controller\UpgradeController::getDocumentationDirectories ( )

protected

Returns

‪string[]

Definition at line 1249 of file UpgradeController.php.

References TYPO3\CMS\Core\Utility\ExtensionManagementUtility\extPath().

Referenced by TYPO3\CMS\Install\Controller\UpgradeController\upgradeDocsGetContentAction().

getDocumentationFiles()

TYPO3\CMS\Install\Controller\UpgradeController::getDocumentationFiles ( string  $version )

protected

Get a list of '.rst' files and their details for "Upgrade documentation" view.

Definition at line 1261 of file UpgradeController.php.

References TYPO3\CMS\Core\Utility\ExtensionManagementUtility\extPath().

Referenced by TYPO3\CMS\Install\Controller\UpgradeController\upgradeDocsGetChangelogForVersionAction().

tcaExtTablesCheckAction()

TYPO3\CMS\Install\Controller\UpgradeController::tcaExtTablesCheckAction

(

ServerRequestInterface

$request

)

Check if loading ext_tables.php files still changes TCA

Definition at line 829 of file UpgradeController.php.

References $GLOBALS, TYPO3\CMS\Install\Controller\UpgradeController\extensionCompatTesterLoadExtLocalconfForExtension(), and TYPO3\CMS\Install\Controller\AbstractController\initializeView().

tcaMigrationsCheckAction()

TYPO3\CMS\Install\Controller\UpgradeController::tcaMigrationsCheckAction

(

ServerRequestInterface

$request

)

Check TCA for needed migrations

Definition at line 873 of file UpgradeController.php.

References $GLOBALS, and TYPO3\CMS\Install\Controller\AbstractController\initializeView().

upgradeDocsGetChangelogForVersionAction()

TYPO3\CMS\Install\Controller\UpgradeController::upgradeDocsGetChangelogForVersionAction

(

ServerRequestInterface

$request

)

Render list of .rst files

Definition at line 923 of file UpgradeController.php.

References TYPO3\CMS\Install\Controller\UpgradeController\assertValidVersion(), TYPO3\CMS\Install\Controller\UpgradeController\getDocumentationFiles(), and TYPO3\CMS\Install\Controller\AbstractController\initializeView().

upgradeDocsGetContentAction()

TYPO3\CMS\Install\Controller\UpgradeController::upgradeDocsGetContentAction

(

ServerRequestInterface

$request

)

Render list of versions

Definition at line 904 of file UpgradeController.php.

References TYPO3\CMS\Install\Controller\UpgradeController\getDocumentationDirectories(), and TYPO3\CMS\Install\Controller\AbstractController\initializeView().

upgradeDocsMarkReadAction()

TYPO3\CMS\Install\Controller\UpgradeController::upgradeDocsMarkReadAction

(

ServerRequestInterface

$request

)

Mark a .rst file as read

Definition at line 944 of file UpgradeController.php.

upgradeDocsUnmarkReadAction()

TYPO3\CMS\Install\Controller\UpgradeController::upgradeDocsUnmarkReadAction

(

ServerRequestInterface

$request

)

Mark a .rst file as not read

Definition at line 958 of file UpgradeController.php.

upgradeWizardsBlockingDatabaseAddsAction()

TYPO3\CMS\Install\Controller\UpgradeController::upgradeWizardsBlockingDatabaseAddsAction

(

)

Check if new tables and fields should be added before executing wizards

Definition at line 972 of file UpgradeController.php.

upgradeWizardsBlockingDatabaseCharsetFixAction()

TYPO3\CMS\Install\Controller\UpgradeController::upgradeWizardsBlockingDatabaseCharsetFixAction

(

)

Fix a broken DB charset setting

Todo:

‪This must be reviewed and decided if we can remove this, move to reports module or if we have other issues with charset on connection and database, or if we need to escalate this down to field level.

Definition at line 1033 of file UpgradeController.php.

upgradeWizardsBlockingDatabaseCharsetTestAction()

TYPO3\CMS\Install\Controller\UpgradeController::upgradeWizardsBlockingDatabaseCharsetTestAction

(

)

Test if database charset is ok

Todo:

‪This must be reviewed and decided if we can remove this, move to reports module or if we have other issues with charset on connection and database, or if we need to escalate this down to field level.

Definition at line 1053 of file UpgradeController.php.

upgradeWizardsBlockingDatabaseExecuteAction()

TYPO3\CMS\Install\Controller\UpgradeController::upgradeWizardsBlockingDatabaseExecuteAction

(

)

Add new tables and fields

Definition at line 997 of file UpgradeController.php.

References $errors.

upgradeWizardsDoneUpgradesAction()

TYPO3\CMS\Install\Controller\UpgradeController::upgradeWizardsDoneUpgradesAction

(

)

Get list of upgrade wizards marked as done

Definition at line 1065 of file UpgradeController.php.

upgradeWizardsExecuteAction()

TYPO3\CMS\Install\Controller\UpgradeController::upgradeWizardsExecuteAction

(

ServerRequestInterface

$request

)

Execute one upgrade wizard

Definition at line 1090 of file UpgradeController.php.

References TYPO3\CMS\Webhooks\Message\$identifier.

upgradeWizardsGetDataAction()

TYPO3\CMS\Install\Controller\UpgradeController::upgradeWizardsGetDataAction

(

ServerRequestInterface

$request

)

Change install tool password

Definition at line 1170 of file UpgradeController.php.

References TYPO3\CMS\Install\Controller\AbstractController\initializeView().

upgradeWizardsInputAction()

TYPO3\CMS\Install\Controller\UpgradeController::upgradeWizardsInputAction

(

ServerRequestInterface

$request

)

Input stage of a specific upgrade wizard

Definition at line 1107 of file UpgradeController.php.

References TYPO3\CMS\Webhooks\Message\$identifier.

upgradeWizardsListAction()

TYPO3\CMS\Install\Controller\UpgradeController::upgradeWizardsListAction

(

)

List available upgrade wizards

Definition at line 1124 of file UpgradeController.php.

upgradeWizardsMarkUndoneAction()

TYPO3\CMS\Install\Controller\UpgradeController::upgradeWizardsMarkUndoneAction

(

ServerRequestInterface

$request

)

Mark a wizard as "not done"

Definition at line 1140 of file UpgradeController.php.

Member Data Documentation

$coreUpdateService

CoreUpdateService TYPO3\CMS\Install\Controller\UpgradeController::$coreUpdateService

protected

Definition at line 87 of file UpgradeController.php.

Referenced by TYPO3\CMS\Install\Controller\UpgradeController\coreUpdateGetDataAction().

$coreVersionService

CoreVersionService TYPO3\CMS\Install\Controller\UpgradeController::$coreVersionService

protected

Definition at line 91 of file UpgradeController.php.

Referenced by TYPO3\CMS\Install\Controller\UpgradeController\coreUpdateGetDataAction().

$matchers

array TYPO3\CMS\Install\Controller\UpgradeController::$matchers

protected

Matcher registry of extension scanner. Node visitors that implement CodeScannerInterface

Definition at line 105 of file UpgradeController.php.

Referenced by TYPO3\CMS\Install\Controller\UpgradeController\extensionScannerScanFileAction().