TYPO3\CMS\Install\Updates\BackendUserStartModuleUpdate Class Reference

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

Public Member Functions
string	getIdentifier ()
string	getTitle ()
string	getDescription ()
bool	updateNecessary ()
string[]	getPrerequisites ()
bool	executeUpdate ()

Detailed Description

Update backend user setting startModule if set to "help_aboutmodules" or "help_CshmanualCshmanual"

This class is only meant to be used within EXT:install and is not part of the TYPO3 Core API.

Definition at line 25 of file BackendUserStartModuleUpdate.php.

Member Function Documentation

executeUpdate()

bool TYPO3\CMS\Install\Updates\BackendUserStartModuleUpdate::executeUpdate

(

)

Performs the database update if backend user's startmodule is "help_aboutmodules" or "help_AboutmodulesAboutmodules" or "help_CshmanualCshmanual"

Returns

‪bool

Implements TYPO3\CMS\Install\Updates\UpgradeWizardInterface.

Definition at line 97 of file BackendUserStartModuleUpdate.php.

getDescription()

string TYPO3\CMS\Install\Updates\BackendUserStartModuleUpdate::getDescription

(

)

Returns

‪string Longer description of this updater

Implements TYPO3\CMS\Install\Updates\UpgradeWizardInterface.

Definition at line 46 of file BackendUserStartModuleUpdate.php.

getIdentifier()

string TYPO3\CMS\Install\Updates\BackendUserStartModuleUpdate::getIdentifier

(

)

Returns

‪string Unique identifier of this updater

Implements TYPO3\CMS\Install\Updates\UpgradeWizardInterface.

Definition at line 30 of file BackendUserStartModuleUpdate.php.

getPrerequisites()

string [] TYPO3\CMS\Install\Updates\BackendUserStartModuleUpdate::getPrerequisites

(

)

Returns

‪string[] All new fields and tables must exist

Implements TYPO3\CMS\Install\Updates\UpgradeWizardInterface.

Definition at line 84 of file BackendUserStartModuleUpdate.php.

getTitle()

string TYPO3\CMS\Install\Updates\BackendUserStartModuleUpdate::getTitle

(

)

Returns

‪string Title of this updater

Implements TYPO3\CMS\Install\Updates\UpgradeWizardInterface.

Definition at line 38 of file BackendUserStartModuleUpdate.php.

updateNecessary()

bool TYPO3\CMS\Install\Updates\BackendUserStartModuleUpdate::updateNecessary

(

)

Checks if an update is needed

Returns

‪bool Whether an update is needed (TRUE) or not (FALSE)

Implements TYPO3\CMS\Install\Updates\UpgradeWizardInterface.

Definition at line 58 of file BackendUserStartModuleUpdate.php.