TYPO3\CMS\Install\Updates\AbstractUpdate Class Reference

Inheritance diagram for TYPO3\CMS\Install\Updates\AbstractUpdate:

Public Member Functions
	getTitle ()
	setTitle ($title)
	getIdentifier ()
	setIdentifier ($identifier)
	shouldRenderWizard ()
	shouldRenderNextButton ()
	checkIfTableExists ($table)
	checkForUpdate (&$description)
	performUpdate (array &$dbQueries, &$customMessages)

Public Attributes
	$pObj
	$userInput
	$versionNumber

Protected Member Functions
	markWizardAsDone ($confValue=1)
	isWizardDone ()
	getDatabaseConnection ()

Protected Attributes
	$title
	$identifier

Detailed Description

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! Generic class that every update wizard class inherits from. Used by the update wizard in the install tool.

Author

Benjamin Mack benni.nosp@m.@typ.nosp@m.o3.or.nosp@m.g

Definition at line 23 of file AbstractUpdate.php.

Member Function Documentation

checkForUpdate()

TYPO3\CMS\Install\Updates\AbstractUpdate::checkForUpdate ( &  $description )

abstract

Checks whether updates are required.

Parameters

string

&$description

The description for the update

Returns

boolean Whether an update is required (TRUE) or not (FALSE)

Referenced by TYPO3\CMS\Install\Updates\AbstractUpdate\checkIfTableExists(), TYPO3\CMS\Install\Updates\AbstractUpdate\shouldRenderNextButton(), and TYPO3\CMS\Install\Updates\AbstractUpdate\shouldRenderWizard().

checkIfTableExists()

TYPO3\CMS\Install\Updates\AbstractUpdate::checkIfTableExists

(

$table

)

Check if given table exists

Parameters

string

$table

Returns

boolean

Definition at line 139 of file AbstractUpdate.php.

References $GLOBALS, TYPO3\CMS\Install\Updates\AbstractUpdate\checkForUpdate(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), and TYPO3\CMS\Install\Updates\AbstractUpdate\performUpdate().

Referenced by TYPO3\CMS\Install\Updates\TruncateSysFileProcessedFileTable\checkForUpdate().

getDatabaseConnection()

TYPO3\CMS\Install\Updates\AbstractUpdate::getDatabaseConnection ( )

protected

Returns

Definition at line 213 of file AbstractUpdate.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Install\Updates\ProcessedFileChecksumUpdate\checkForUpdate(), and TYPO3\CMS\Install\Updates\ProcessedFileChecksumUpdate\performUpdate().

getIdentifier()

TYPO3\CMS\Install\Updates\AbstractUpdate::getIdentifier

(

)

Returns the identifier of this class

Returns

string The identifier of this update wizard

Definition at line 89 of file AbstractUpdate.php.

References TYPO3\CMS\Install\Updates\AbstractUpdate\$identifier.

getTitle()

TYPO3\CMS\Install\Updates\AbstractUpdate::getTitle

(

)

Returns the title attribute

Returns

string The title of this update wizard

Definition at line 66 of file AbstractUpdate.php.

References TYPO3\CMS\Install\Updates\AbstractUpdate\$identifier, and TYPO3\CMS\Install\Updates\AbstractUpdate\$title.

isWizardDone()

TYPO3\CMS\Install\Updates\AbstractUpdate::isWizardDone ( )

protected

Checks if this wizard has been "done" before

Returns

boolean TRUE if wizard has been done before, FALSE otherwise

Definition at line 198 of file AbstractUpdate.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Install\Updates\TruncateSysFileProcessedFileTable\checkForUpdate(), TYPO3\CMS\Install\Updates\ProcessedFileChecksumUpdate\checkForUpdate(), TYPO3\CMS\Install\Updates\FilemountUpdateWizard\checkForUpdate(), and TYPO3\CMS\Rtehtmlarea\Hook\Install\DeprecatedRteProperties\checkForUpdate().

markWizardAsDone()

TYPO3\CMS\Install\Updates\AbstractUpdate::markWizardAsDone (   $confValue = 1 )

protected

Marks some wizard as being "seen" so that it not shown again.

Writes the info in LocalConfiguration.php

Parameters

mixed

$confValue

The configuration is set to this value

Returns

void

Definition at line 189 of file AbstractUpdate.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Referenced by TYPO3\CMS\Install\Updates\TruncateSysFileProcessedFileTable\performUpdate(), TYPO3\CMS\Install\Updates\ProcessedFileChecksumUpdate\performUpdate(), TYPO3\CMS\Install\Updates\FilemountUpdateWizard\performUpdate(), TYPO3\CMS\Install\Updates\FileIdentifierHashUpdate\performUpdate(), TYPO3\CMS\Rtehtmlarea\Hook\Install\DeprecatedRteProperties\performUpdate(), and TYPO3\CMS\Install\Updates\TceformsUpdateWizard\performUpdate().

performUpdate()

TYPO3\CMS\Install\Updates\AbstractUpdate::performUpdate ( array &  $dbQueries, &  $customMessages  )

abstract

Performs the accordant updates.

Parameters

array	&$dbQueries	Queries done in this update
mixed	&$customMessages	Custom messages

Returns

boolean Whether everything went smoothly or not

Referenced by TYPO3\CMS\Install\Updates\MediaFlexformUpdate\checkForUpdate(), and TYPO3\CMS\Install\Updates\AbstractUpdate\checkIfTableExists().

setIdentifier()

TYPO3\CMS\Install\Updates\AbstractUpdate::setIdentifier

(

$identifier

)

Sets the identifier attribute

Parameters

string

$identifier

The identifier of this update wizard

Returns

void

Definition at line 99 of file AbstractUpdate.php.

References TYPO3\CMS\Install\Updates\AbstractUpdate\$identifier.

setTitle()

TYPO3\CMS\Install\Updates\AbstractUpdate::setTitle

(

$title

)

Sets the title attribute

Parameters

string

$title

The title of this update wizard

Returns

void

Definition at line 80 of file AbstractUpdate.php.

References TYPO3\CMS\Install\Updates\AbstractUpdate\$title.

shouldRenderNextButton()

TYPO3\CMS\Install\Updates\AbstractUpdate::shouldRenderNextButton

(

)

Simple wrapper function that helps to check whether (if) this feature is cool if you want to tell the user that the update wizard is working fine, just as output (useful for the character set / utf8 wizard)

Returns

boolean If the wizard should render the Next() button on the overview page

See also

checkForUpdate()

Definition at line 126 of file AbstractUpdate.php.

References $result, and TYPO3\CMS\Install\Updates\AbstractUpdate\checkForUpdate().

shouldRenderWizard()

TYPO3\CMS\Install\Updates\AbstractUpdate::shouldRenderWizard

(

)

Simple wrapper function that helps dealing with the compatibility layer that some update wizards don't have a second parameter thus, it evaluates everything already

Returns

boolean If the wizard should be shown at all on the overview page

See also

checkForUpdate()

Definition at line 111 of file AbstractUpdate.php.

References $result, and TYPO3\CMS\Install\Updates\AbstractUpdate\checkForUpdate().

Member Data Documentation

$identifier

TYPO3\CMS\Install\Updates\AbstractUpdate::$identifier

protected

Definition at line 37 of file AbstractUpdate.php.

Referenced by TYPO3\CMS\Install\Updates\AbstractUpdate\getIdentifier(), TYPO3\CMS\Install\Updates\AbstractUpdate\getTitle(), and TYPO3\CMS\Install\Updates\AbstractUpdate\setIdentifier().

$pObj

TYPO3\CMS\Install\Updates\AbstractUpdate::$pObj

Definition at line 44 of file AbstractUpdate.php.

$title

TYPO3\CMS\Install\Updates\AbstractUpdate::$title

protected

Definition at line 30 of file AbstractUpdate.php.

Referenced by TYPO3\CMS\Install\Updates\AbstractUpdate\getTitle(), and TYPO3\CMS\Install\Updates\AbstractUpdate\setTitle().

$userInput

TYPO3\CMS\Install\Updates\AbstractUpdate::$userInput

Definition at line 51 of file AbstractUpdate.php.

$versionNumber

TYPO3\CMS\Install\Updates\AbstractUpdate::$versionNumber

Definition at line 59 of file AbstractUpdate.php.