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 Symfony\Component\Console\Output\OutputInterface;
use ‪TYPO3\CMS\Core\Database\ConnectionPool;
use ‪TYPO3\CMS\Core\Registry;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
abstract class ‪AbstractUpdate implements ‪UpgradeWizardInterface, ‪ChattyInterface
{
    public function ‪__construct()
    {
        trigger_error('Deprecated since TYPO3 v9, will be removed in TYPO3 v10.0, use UpgradeWizardInterface directly. affected class: ' . get_class($this), E_USER_DEPRECATED);
    }
    protected ‪$title;
 
    protected ‪$identifier;
 
    public ‪$userInput;
 
    protected ‪$output;
 
    public function ‪getTitle(): string
    {
        trigger_error(
            'Deprecated since TYPO3 v9, will be removed in TYPO3 v10.0, use UpgradeWizardInterface directly. affected class: ' . get_class($this),
            E_USER_DEPRECATED
        );
        if ($this->title) {
            return ‪$this->title;
        }
        return ‪$this->identifier;
    }
 
    public function ‪setTitle(‪$title)
    {
        trigger_error(
            'Deprecated since TYPO3 v9, will be removed in TYPO3 v10.0, use UpgradeWizardInterface directly. affected class: ' . get_class($this),
            E_USER_DEPRECATED
        );
        $this->title = ‪$title;
    }
 
    public function ‪getIdentifier(): string
    {
        trigger_error(
            'Deprecated since TYPO3 v9, will be removed in TYPO3 v10.0, use UpgradeWizardInterface directly. affected class: ' . get_class($this),
            E_USER_DEPRECATED
        );
        return $this->identifier ?? static::class;
    }
 
    public function ‪setIdentifier(‪$identifier)
    {
        trigger_error(
            'Deprecated since TYPO3 v9, will be removed in TYPO3 v10.0, use UpgradeWizardInterface directly. affected class: ' . get_class($this),
            E_USER_DEPRECATED
        );
        $this->identifier = ‪$identifier;
    }
 
    public function ‪shouldRenderWizard()
    {
        trigger_error(
            'Deprecated since TYPO3 v9, will be removed in TYPO3 v10.0, use UpgradeWizardInterface directly. affected class: ' . get_class($this),
            E_USER_DEPRECATED
        );
        $explanation = '';
        $result = $this->‪checkForUpdate($explanation);
        return (bool)$result === true;
    }
 
    protected function ‪checkIfTableExists($table)
    {
        trigger_error(
            'Deprecated since TYPO3 v9, will be removed in TYPO3 v10.0, use UpgradeWizardInterface directly. affected class: ' . get_class($this),
            E_USER_DEPRECATED
        );
        $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)
    {
        trigger_error(
            'Deprecated since TYPO3 v9, will be removed in TYPO3 v10.0, use UpgradeWizardInterface directly. affected class: ' . get_class($this),
            E_USER_DEPRECATED
        );
        $installUtility = GeneralUtility::makeInstance(
            \‪TYPO3\CMS\Extensionmanager\Utility\InstallUtility::class
        );
        $installUtility->install($extensionKeys);
    }
 
    protected function ‪markWizardAsDone($confValue = 1)
    {
        trigger_error(
            'Deprecated since TYPO3 v9, will be removed in TYPO3 v10.0, use UpgradeWizardInterface directly. affected class: ' . get_class($this),
            E_USER_DEPRECATED
        );
        GeneralUtility::makeInstance(Registry::class)->set('installUpdate', static::class, $confValue);
    }
 
    protected function ‪isWizardDone()
    {
        trigger_error(
            'Deprecated since TYPO3 v9, will be removed in TYPO3 v10.0, use UpgradeWizardInterface directly. affected class: ' . get_class($this),
            E_USER_DEPRECATED
        );
        $wizardClassName = static::class;
        return GeneralUtility::makeInstance(Registry::class)->get('installUpdate', $wizardClassName, false);
    }
 
    public function ‪getDescription(): string
    {
        trigger_error(
            'Deprecated since TYPO3 v9, will be removed in TYPO3 v10.0, use UpgradeWizardInterface directly. affected class: ' . get_class($this),
            E_USER_DEPRECATED
        );
        return '';
    }
 
    public function ‪executeUpdate(): bool
    {
        trigger_error(
            'Deprecated since TYPO3 v9, will be removed in TYPO3 v10.0, use UpgradeWizardInterface directly. affected class: ' . get_class($this),
            E_USER_DEPRECATED
        );
        $queries = [];
        $message = '';
        $result = $this->‪performUpdate($queries, $message);
        $this->output->write($message);
        return $result;
    }
 
    public function ‪updateNecessary(): bool
    {
        trigger_error(
            'Deprecated since TYPO3 v9, will be removed in TYPO3 v10.0, use UpgradeWizardInterface directly. affected class: ' . get_class($this),
            E_USER_DEPRECATED
        );
        $description = '';
        $result = $this->‪checkForUpdate($description);
        $this->output->write($description);
        return $result;
    }
 
    public function ‪getPrerequisites(): array
    {
        trigger_error(
            'Deprecated since TYPO3 v9, will be removed in TYPO3 v10.0, use UpgradeWizardInterface directly. affected class: ' . get_class($this),
            E_USER_DEPRECATED
        );
        return [
            DatabaseUpdatedPrerequisite::class
        ];
    }
 
    public function ‪setOutput(OutputInterface ‪$output): void
    {
        trigger_error(
            'Deprecated since TYPO3 v9, will be removed in TYPO3 v10.0, use UpgradeWizardInterface directly. affected class: ' . get_class($this),
            E_USER_DEPRECATED
        );
        $this->output = ‪$output;
    }
}