WizardDoneToRegistry.php

Go to the documentation of this file.

<?php
namespace ‪TYPO3\CMS\Install\Updates;
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
use TYPO3\CMS\Core\Configuration\ConfigurationManager;
use ‪TYPO3\CMS\Core\Registry;
use ‪TYPO3\CMS\Core\Utility\Exception\MissingArrayPathException;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪WizardDoneToRegistry implements ‪UpgradeWizardInterface
{
    public function ‪getIdentifier(): string
    {
        return 'wizardDoneToRegistry';
    }
 
    public function ‪getTitle(): string
    {
        return 'Move "wizard done" flags from LocalConfiguration.php to system registry';
    }
 
    public function ‪getDescription(): string
    {
        return 'Moves all "wizard done" flags from LocalConfiguration.php to system registry.';
    }
 
    public function ‪updateNecessary(): bool
    {
        $result = false;
        try {
            $wizardsDone = GeneralUtility::makeInstance(ConfigurationManager::class)
                ->getLocalConfigurationValueByPath('INSTALL/wizardDone');
            if (!empty($wizardsDone)) {
                $result = true;
            }
        } catch (‪MissingArrayPathException $e) {
            // Result stays false with broken path
        }
        return $result;
    }
 
    public function ‪getPrerequisites(): array
    {
        return [
            DatabaseUpdatedPrerequisite::class
        ];
    }
 
    public function ‪executeUpdate(): bool
    {
        $configurationManager = GeneralUtility::makeInstance(ConfigurationManager::class);
        $registry = GeneralUtility::makeInstance(Registry::class);
        $wizardsDone = $configurationManager->getLocalConfigurationValueByPath('INSTALL/wizardDone');
        $configurationKeysToRemove = [];
        foreach ($wizardsDone as $wizardClassName => $value) {
            $registry->set('installUpdate', $wizardClassName, $value);
            $configurationKeysToRemove[] = 'INSTALL/wizardDone/' . $wizardClassName;
        }
        $configurationKeysToRemove[] = 'INSTALL/wizardDone';
        $configurationManager->removeLocalConfigurationKeysByPath($configurationKeysToRemove);
        return true;
    }
}