TYPO3\CMS\Install\Updates\CompatVersionUpdate Class Reference

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

Public Member Functions
	checkForUpdate (&$description)
	getUserInput ($inputPrefix)
	checkUserInput (&$customMessages)
	performUpdate (array &$dbQueries, &$customMessages)
Public Member Functions inherited from TYPO3\CMS\Install\Updates\AbstractUpdate
	getTitle ()
	setTitle ($title)
	getIdentifier ()
	setIdentifier ($identifier)
	shouldRenderWizard ()
	shouldRenderNextButton ()
	checkIfTableExists ($table)
	checkForUpdate (&$description)
	performUpdate (array &$dbQueries, &$customMessages)

Protected Member Functions
	compatVersionIsCurrent ()
	showChangesNeeded ($inputPrefix='')
Protected Member Functions inherited from TYPO3\CMS\Install\Updates\AbstractUpdate
	markWizardAsDone ($confValue=1)
	isWizardDone ()
	getDatabaseConnection ()

Protected Attributes
	$title = 'Version Compatibility'
Protected Attributes inherited from TYPO3\CMS\Install\Updates\AbstractUpdate
	$title
	$identifier

Additional Inherited Members
Public Attributes inherited from TYPO3\CMS\Install\Updates\AbstractUpdate
	$pObj
	$userInput
	$versionNumber

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! Contains the update class for the compatibility version. Used by the update wizard in the install tool.

Author

Sebastian Kurfürst <sebas.nosp@m.tian.nosp@m.@garb.nosp@m.age-.nosp@m.group.nosp@m..de

Definition at line 23 of file CompatVersionUpdate.php.

Member Function Documentation

checkForUpdate()

TYPO3\CMS\Install\Updates\CompatVersionUpdate::checkForUpdate

(

&

$description

)

Function which checks if update is needed. Called in the beginning of an update process.

Parameters

string

&$description

Pointer to description for the update

Returns

boolean TRUE if update is needs to be performed, FALSE otherwise.

Definition at line 36 of file CompatVersionUpdate.php.

References $GLOBALS, and TYPO3\CMS\Install\Updates\CompatVersionUpdate\compatVersionIsCurrent().

checkUserInput()

TYPO3\CMS\Install\Updates\CompatVersionUpdate::checkUserInput

(

&

$customMessages

)

Checks if user input is valid

Parameters

string

Pointer to output custom messages

Returns

boolean TRUE if user input is correct, then the update is performed. When FALSE, return to getUserInput

Definition at line 135 of file CompatVersionUpdate.php.

References $GLOBALS, TYPO3\CMS\Install\Updates\CompatVersionUpdate\compatVersionIsCurrent(), and TYPO3\CMS\Core\Utility\VersionNumberUtility\convertVersionNumberToInteger().

compatVersionIsCurrent()

TYPO3\CMS\Install\Updates\CompatVersionUpdate::compatVersionIsCurrent ( )

protected

Checks if compatibility version is set to current version

Returns

boolean TRUE if compat version is equal the current version

Definition at line 183 of file CompatVersionUpdate.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Install\Updates\CompatVersionUpdate\checkForUpdate(), TYPO3\CMS\Install\Updates\CompatVersionUpdate\checkUserInput(), and TYPO3\CMS\Install\Updates\CompatVersionUpdate\getUserInput().

getUserInput()

TYPO3\CMS\Install\Updates\CompatVersionUpdate::getUserInput

(

$inputPrefix

)

Second step: get user input if needed

Parameters

string

Input prefix, all names of form fields have to start with this. Append custom name in [ ... ]

Returns

string HTML output

Definition at line 64 of file CompatVersionUpdate.php.

References $GLOBALS, TYPO3\CMS\Install\Updates\CompatVersionUpdate\compatVersionIsCurrent(), and TYPO3\CMS\Install\Updates\CompatVersionUpdate\showChangesNeeded().

performUpdate()

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

Performs the update itself

Parameters

array	$dbQueries	where to insert all DB queries made, so they can be shown to the user if wanted
string	$customMessages	to output custom messages

Returns

boolean TRUE if update succeeded, FALSE otherwise

Definition at line 166 of file CompatVersionUpdate.php.

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

showChangesNeeded()

TYPO3\CMS\Install\Updates\CompatVersionUpdate::showChangesNeeded (   $inputPrefix = '' )

protected

Show changes needed

Parameters

string

Input prefix to prepend all form fields with.

Returns

string HTML output

Definition at line 197 of file CompatVersionUpdate.php.

References $GLOBALS, and TYPO3\CMS\Core\Utility\VersionNumberUtility\convertVersionNumberToInteger().

Referenced by TYPO3\CMS\Install\Updates\CompatVersionUpdate\getUserInput().

Member Data Documentation

$title

TYPO3\CMS\Install\Updates\CompatVersionUpdate::$title = 'Version Compatibility'

protected

Definition at line 28 of file CompatVersionUpdate.php.