AbstractUpdate.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\Database\ConnectionPool;
use TYPO3\CMS\Core\Registry;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Install\Controller\Action\Tool\UpgradeWizard;

abstract class AbstractUpdate
{
    protected $title;

    protected $identifier;

    public $pObj;

    public $userInput;

    public $versionNumber;

    public function getTitle()
    {
        if ($this->title) {
            return $this->title;
        }
        return $this->identifier;
    }

    public function setTitle($title)
    {
        $this->title = $title;
    }

    public function getIdentifier()
    {
        return $this->identifier;
    }

    public function setIdentifier($identifier)
    {
        $this->identifier = $identifier;
    }

    public function shouldRenderWizard()
    {
        $explanation = '';
        $result = $this->checkForUpdate($explanation);
        return (bool)$result === true;
    }

    public function shouldRenderNextButton()
    {
        $showUpdate = 0;
        $explanation = '';
        $result = $this->checkForUpdate($explanation, $showUpdate);
        return $showUpdate != 2 || $result;
    }

    public function checkIfTableExists($table)
    {
        $tableExists = GeneralUtility::makeInstance(ConnectionPool::class)
            ->getConnectionForTable($table)
            ->getSchemaManager()
            ->tablesExist([$table]);

        return $tableExists;
    }

    abstract public function checkForUpdate(&$description);

    abstract public function performUpdate(array &$dbQueries, &$customMessage);

    protected function installExtensions(array $extensionKeys)
    {
        $installUtility = GeneralUtility::makeInstance(
            \TYPO3\CMS\Extensionmanager\Utility\InstallUtility::class
        );
        $installUtility->install($extensionKeys);
    }

    protected function markWizardAsDone($confValue = 1)
    {
        GeneralUtility::makeInstance(Registry::class)->set('installUpdate', get_class($this), $confValue);
    }

    protected function isWizardDone()
    {
        $wizardClassName = get_class($this);
        $done = GeneralUtility::makeInstance(Registry::class)->get('installUpdate', $wizardClassName, false);

        // Fall back in case the wizard for migration of "wizard done" flags to system registry was not run yet
        if (!$done) {
            try {
                GeneralUtility::makeInstance(ConfigurationManager::class)
                    ->getLocalConfigurationValueByPath('INSTALL/wizardDone/' . $wizardClassName);
                $done = true;
            } catch (\RuntimeException $e) {
            }
        }

        return $done;
    }
}