AbstractUpdate.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Install\Updates;

abstract class AbstractUpdate {

    protected $title;

    protected $identifier;

    public $pObj;

    public $userInput;

    public $versionNumber;

    public function getTitle() {
        if ($this->title) {
            return $this->title;
        } else {
            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() {
        $showUpdate = 0;
        $explanation = '';
        $result = $this->checkForUpdate($explanation, $showUpdate);
        return $showUpdate > 0 || $result == TRUE;
    }

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

    public function checkIfTableExists($table) {
        $databaseTables = $GLOBALS['TYPO3_DB']->admin_get_tables();
        if (array_key_exists($table, $databaseTables)) {
            return TRUE;
        }
        return FALSE;
    }

    abstract public function checkForUpdate(&$description);

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

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

    protected function markWizardAsDone($confValue = 1) {
        \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Configuration\\ConfigurationManager')->setLocalConfigurationValueByPath('INSTALL/wizardDone/' . get_class($this), $confValue);
    }

    protected function isWizardDone() {
        $wizardClassName = get_class($this);
        $done = FALSE;
        if (
            isset($GLOBALS['TYPO3_CONF_VARS']['INSTALL']['wizardDone'][$wizardClassName])
            && $GLOBALS['TYPO3_CONF_VARS']['INSTALL']['wizardDone'][$wizardClassName]
        ) {
            $done = TRUE;
        }
        return $done;
    }

    protected function getDatabaseConnection() {
        return $GLOBALS['TYPO3_DB'];
    }

}