TYPO3\CMS\Install\Service\UpgradeWizardsService Class Reference

Public Member Functions
	__construct (private readonly UpgradeWizardRegistry $upgradeWizardRegistry, private readonly Registry $registry,)
array	listOfWizardsDone ()
array	listOfRowUpdatersDone ()
bool	markWizardUndone (string $identifier)
array	getUpgradeWizardsList ()
	getWizardInformationByIdentifier (string $identifier)
	getWizardUserInput (string $identifier)
	executeWizard (string $identifier, array $values)
	markWizardAsDone (UpgradeWizardInterface $upgradeWizard)
bool	isWizardDone (string $identifier)
	getUpgradeWizard (string $identifier)
	getUpgradeWizardIdentifiers ()
	getNonRepeatableUpgradeWizards ()

Private Member Functions
	assertIdentifierIsValid (string $identifier)

Private Attributes
StreamOutput	$output

Detailed Description

Service class helps to manage upgrade wizards.

This class is only meant to be used within EXT:install and is not part of the TYPO3 Core API.

Definition at line 39 of file UpgradeWizardsService.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Install\Service\UpgradeWizardsService::__construct	(	private readonly UpgradeWizardRegistry	$upgradeWizardRegistry,
		private readonly Registry	$registry
	)

Definition at line 43 of file UpgradeWizardsService.php.

Member Function Documentation

assertIdentifierIsValid()

TYPO3\CMS\Install\Service\UpgradeWizardsService::assertIdentifierIsValid ( string  $identifier )

private

Validate identifier exists in upgrade wizard list

Exceptions

Definition at line 364 of file UpgradeWizardsService.php.

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

Referenced by TYPO3\CMS\Install\Service\UpgradeWizardsService\executeWizard(), TYPO3\CMS\Install\Service\UpgradeWizardsService\getWizardInformationByIdentifier(), TYPO3\CMS\Install\Service\UpgradeWizardsService\getWizardUserInput(), TYPO3\CMS\Install\Service\UpgradeWizardsService\isWizardDone(), and TYPO3\CMS\Install\Service\UpgradeWizardsService\markWizardUndone().

executeWizard()

TYPO3\CMS\Install\Service\UpgradeWizardsService::executeWizard	(	string	$identifier,
		array	$values
	)

Execute a single update wizard

Exceptions

Definition at line 244 of file UpgradeWizardsService.php.

References TYPO3\CMS\Webhooks\Message\$identifier, TYPO3\CMS\Install\Service\UpgradeWizardsService\assertIdentifierIsValid(), and TYPO3\CMS\Install\Service\UpgradeWizardsService\markWizardAsDone().

getNonRepeatableUpgradeWizards()

TYPO3\CMS\Install\Service\UpgradeWizardsService::getNonRepeatableUpgradeWizards

(

)

Definition at line 348 of file UpgradeWizardsService.php.

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

getUpgradeWizard()

TYPO3\CMS\Install\Service\UpgradeWizardsService::getUpgradeWizard

(

string

$identifier

)

Wrapper to catch \UnexpectedValueException for backwards compatibility reasons

Definition at line 334 of file UpgradeWizardsService.php.

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

getUpgradeWizardIdentifiers()

TYPO3\CMS\Install\Service\UpgradeWizardsService::getUpgradeWizardIdentifiers

(

)

Definition at line 343 of file UpgradeWizardsService.php.

getUpgradeWizardsList()

array TYPO3\CMS\Install\Service\UpgradeWizardsService::getUpgradeWizardsList

(

)

Get list of registered upgrade wizards not marked done.

Returns

‪array List of upgrade wizards in correct order with detail information

Definition at line 146 of file UpgradeWizardsService.php.

References TYPO3\CMS\Webhooks\Message\$identifier, TYPO3\CMS\Install\Service\UpgradeWizardsService\getWizardInformationByIdentifier(), and TYPO3\CMS\Install\Service\UpgradeWizardsService\isWizardDone().

getWizardInformationByIdentifier()

TYPO3\CMS\Install\Service\UpgradeWizardsService::getWizardInformationByIdentifier

(

string

$identifier

)

Definition at line 159 of file UpgradeWizardsService.php.

References TYPO3\CMS\Webhooks\Message\$identifier, and TYPO3\CMS\Install\Service\UpgradeWizardsService\assertIdentifierIsValid().

Referenced by TYPO3\CMS\Install\Service\UpgradeWizardsService\getUpgradeWizardsList().

getWizardUserInput()

TYPO3\CMS\Install\Service\UpgradeWizardsService::getWizardUserInput

(

string

$identifier

)

Execute the "get user input" step of a wizard

Exceptions

Definition at line 193 of file UpgradeWizardsService.php.

References TYPO3\CMS\Webhooks\Message\$identifier, and TYPO3\CMS\Install\Service\UpgradeWizardsService\assertIdentifierIsValid().

isWizardDone()

bool TYPO3\CMS\Install\Service\UpgradeWizardsService::isWizardDone

(

string

$identifier

)

Checks if this wizard has been "done" before

Returns

‪bool TRUE if wizard has been done before, FALSE otherwise

Exceptions

Definition at line 320 of file UpgradeWizardsService.php.

References TYPO3\CMS\Webhooks\Message\$identifier, and TYPO3\CMS\Install\Service\UpgradeWizardsService\assertIdentifierIsValid().

Referenced by TYPO3\CMS\Install\Service\UpgradeWizardsService\getUpgradeWizardsList().

listOfRowUpdatersDone()

array TYPO3\CMS\Install\Service\UpgradeWizardsService::listOfRowUpdatersDone

(

)

Returns

‪array List of row updaters marked as done in registry

Exceptions

Definition at line 77 of file UpgradeWizardsService.php.

Referenced by TYPO3\CMS\Install\Service\UpgradeWizardsService\markWizardUndone().

listOfWizardsDone()

array TYPO3\CMS\Install\Service\UpgradeWizardsService::listOfWizardsDone

(

)

Returns

‪array List of wizards marked as done in registry

Definition at line 57 of file UpgradeWizardsService.php.

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

Referenced by TYPO3\CMS\Install\Service\UpgradeWizardsService\markWizardUndone().

markWizardAsDone()

TYPO3\CMS\Install\Service\UpgradeWizardsService::markWizardAsDone

(

UpgradeWizardInterface

$upgradeWizard

)

Marks some wizard as being "seen" so that it not shown again. Writes the info in system/settings.php

Exceptions

Definition at line 309 of file UpgradeWizardsService.php.

Referenced by TYPO3\CMS\Install\Service\UpgradeWizardsService\executeWizard().

markWizardUndone()

bool TYPO3\CMS\Install\Service\UpgradeWizardsService::markWizardUndone

(

string

$identifier

)

Mark one wizard as undone. This can be a "casual" wizard or a single "row updater".

Parameters

string

$identifier

‪Wizard or RowUpdater identifier

Returns

‪bool True if wizard has been marked as undone

Exceptions

Definition at line 111 of file UpgradeWizardsService.php.

References TYPO3\CMS\Webhooks\Message\$identifier, TYPO3\CMS\Install\Service\UpgradeWizardsService\assertIdentifierIsValid(), TYPO3\CMS\Install\Service\UpgradeWizardsService\listOfRowUpdatersDone(), and TYPO3\CMS\Install\Service\UpgradeWizardsService\listOfWizardsDone().

Member Data Documentation

$output

StreamOutput TYPO3\CMS\Install\Service\UpgradeWizardsService::$output

private

Definition at line 41 of file UpgradeWizardsService.php.