Deprecation: #106947 - Move upgrade wizard related interfaces and attribute to EXT:core 

Description 

EXT:install provided a couple of interfaces to allow implementing upgrade wizards, along with the PHP attribute #[UpgradeWizard(...)] to register them.

Since TYPO3 v13 it is possible to run TYPO3 without EXT:install being installed. However, this advantage could often not be utilised sensibly, since extensions still needed to require EXT:install as a dependency in order to ship upgrade wizards, because the implemented interfaces needed to be available.

For this reason the following interfaces, classes and attributes are now moved into EXT:core, and their former counterparts in EXT:install now extend these Core classes:

• Attribute \TYPO3\CMS\Install\Attribute\UpgradeWizard to \TYPO3\CMS\Core\Attribute\UpgradeWizard
• Interface \TYPO3\CMS\Install\Updates\ChattyInterface to \TYPO3\CMS\Core\Upgrades\ChattyInterface
• Interface \TYPO3\CMS\Install\Updates\ConfirmableInterface to \TYPO3\CMS\Core\Upgrades\ConfirmableInterface
• Interface \TYPO3\CMS\Install\Updates\PrerequisiteInterface to \TYPO3\CMS\Core\Upgrades\PrerequisiteInterface
• Interface \TYPO3\CMS\Install\Updates\RepeatableInterface to \TYPO3\CMS\Core\Upgrades\RepeatableInterface
• Interface \TYPO3\CMS\Install\Updates\UpgradeWizardInterface to \TYPO3\CMS\Core\Upgrades\UpgradeWizardInterface
• Class \TYPO3\CMS\Install\Updates\Confirmation to \TYPO3\CMS\Core\Upgrades\Confirmation
• Class \TYPO3\CMS\Install\Updates\DatabaseUpdatedPrerequisite to \TYPO3\CMS\Core\Upgrades\DatabaseUpdatedPrerequisite
• Class \TYPO3\CMS\Install\Updates\ReferenceIndexUpdatedPrerequisite to \TYPO3\CMS\Core\Upgrades\ReferenceIndexUpdatedPrerequisite
• AbstractClass \TYPO3\CMS\Install\Updates\AbstractListTypeToCTypeUpdate to \TYPO3\CMS\Core\Upgrades\AbstractListTypeToCTypeUpdate

The following internal class has been moved without an alternative:

• Class :phpTYPO3CMSInstallUpdatesPrerequisiteCollection to \TYPO3\CMS\Core\Upgrades\PrerequisiteCollection

Extension authors are encouraged to migrate their upgrade wizards to the new core interface, in order to drop their dependency on EXT:install.

Impact 

Using the listed interfaces and the attribute in the scope of EXT:core allow extension authors to optionally provide their extension upgrade wizards. EXT:install can then be set as a "suggested" dependency, and is no longer required to be mandatory.

The usage of these old interfaces from EXT:install is now deprecated.

Affected installations 

Installations missing EXT:install or having extensions providing upgrade wizards using the old namespace.

Migration 

Upgrade custom upgrade wizards to use the new attribute, interfaces and/or classes from the EXT:core namespace, instead of EXT:install:

<?php

declare(strict_types=1);

namespace MyVendor\MyExtension\Upgrades;

use TYPO3\CMS\Install\Attribute\UpgradeWizard;
use TYPO3\CMS\Install\Updates\ChattyInterface;
use TYPO3\CMS\Install\Updates\ConfirmableInterface;
use TYPO3\CMS\Install\Updates\RepeatableInterface;
use TYPO3\CMS\Install\Updates\UpgradeWizardInterface;

#[UpgradeWizard('myExtensionCustomUpgradeWizardIdentifier')]
class CustomUpgradeWizard implements UpgradeWizardInterface, ChattyInterface, RepeatableInterface
{
    // ...
}

<?php

declare(strict_types=1);

namespace MyVendor\MyExtension\Upgrades;

use TYPO3\CMS\Core\Attribute\UpgradeWizard;
use TYPO3\CMS\Core\Upgrades\ChattyInterface;
use TYPO3\CMS\Core\Upgrades\ConfirmableInterface;
use TYPO3\CMS\Core\Upgrades\RepeatableInterface;
use TYPO3\CMS\Core\Upgrades\UpgradeWizardInterface;

#[UpgradeWizard('myExtensionCustomUpgradeWizardIdentifier')]
class CustomUpgradeWizard implements UpgradeWizardInterface, ChattyInterface, RepeatableInterface
{
    // ...
}

<?php

declare(strict_types=1);

namespace MyVendor\MyExtension\Upgrades;

use TYPO3\CMS\Core\Attribute\UpgradeWizard;
use TYPO3\CMS\Install\Updates\AbstractListTypeToCTypeUpdate;

#[UpgradeWizard('CustomCTypeMigration')]
final class CustomCTypeMigration extends AbstractListTypeToCTypeUpdate
{
    // ...
}

<?php

declare(strict_types=1);

namespace MyVendor\MyExtension\Upgrades;

use TYPO3\CMS\Core\Attribute\UpgradeWizard;
use TYPO3\CMS\Core\Upgrades\AbstractListTypeToCTypeUpdate;

#[UpgradeWizard('CustomCTypeMigration')]
final class CustomCTypeMigration extends AbstractListTypeToCTypeUpdate
{
    // ...
}

<?php

declare(strict_types=1);

namespace MyVendor\MyExtension\Upgrades;

use TYPO3\CMS\Core\Attribute\UpgradeWizard;
use TYPO3\CMS\Core\Upgrades\ChattyInterface;
use TYPO3\CMS\Core\Upgrades\ConfirmableInterface;
use TYPO3\CMS\Core\Upgrades\RepeatableInterface;
use TYPO3\CMS\Core\Upgrades\UpgradeWizardInterface;
use TYPO3\CMS\Install\Updates\DatabaseUpdatedPrerequisite;
use TYPO3\CMS\Install\Updates\ReferenceIndexUpdatedPrerequisite;

#[UpgradeWizard('myExtensionCustomUpgradeWizardIdentifier')]
class CustomUpgradeWizard implements UpgradeWizardInterface, ChattyInterface, RepeatableInterface
{
    /**
     * @return string[] All new fields and tables must exist
     */
    public function getPrerequisites(): array
    {
        return [
            DatabaseUpdatedPrerequisite::class,
            ReferenceIndexUpdatedPrerequisite::class,
        ];
    }
}

<?php

declare(strict_types=1);

namespace MyVendor\MyExtension\Upgrades;

use TYPO3\CMS\Core\Attribute\UpgradeWizard;
use TYPO3\CMS\Core\Upgrades\ChattyInterface;
use TYPO3\CMS\Core\Upgrades\ConfirmableInterface;
use TYPO3\CMS\Core\Upgrades\RepeatableInterface;
use TYPO3\CMS\Core\Upgrades\UpgradeWizardInterface;
use TYPO3\CMS\Core\Upgrades\DatabaseUpdatedPrerequisite;
use TYPO3\CMS\Core\Upgrades\ReferenceIndexUpdatedPrerequisite;

#[UpgradeWizard('myExtensionCustomUpgradeWizardIdentifier')]
class CustomUpgradeWizard implements UpgradeWizardInterface, ChattyInterface, RepeatableInterface
{
    /**
     * @return string[] All new fields and tables must exist
     */
    public function getPrerequisites(): array
    {
        return [
            DatabaseUpdatedPrerequisite::class,
            ReferenceIndexUpdatedPrerequisite::class,
        ];
    }
}