TYPO3\CMS\Install\Updates\WorkspacesNotificationSettingsUpdate Class Reference

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

Public Member Functions
	checkForUpdate (&$description)
	performUpdate (array &$databaseQueries, &$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
	prepareWorkspaceUpdate (array $workspaceRecord)
	prepareStageUpdate (array $stageRecord)
	mapSettings (array $record, array $update, $from='', $to='')
Protected Member Functions inherited from TYPO3\CMS\Install\Updates\AbstractUpdate
	markWizardAsDone ($confValue=1)
	isWizardDone ()
	getDatabaseConnection ()

Protected Attributes
	$title = 'Migrate the workspaces notification settings to the enhanced schema'
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

Migrate the workspaces notification settings to the enhanced schema.

Definition at line 22 of file WorkspacesNotificationSettingsUpdate.php.

Member Function Documentation

checkForUpdate()

TYPO3\CMS\Install\Updates\WorkspacesNotificationSettingsUpdate::checkForUpdate

(

&

$description

)

Checks if an update is needed

Parameters

string

&$description

The description for the update

Returns

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

Definition at line 35 of file WorkspacesNotificationSettingsUpdate.php.

References TYPO3\CMS\Install\Updates\AbstractUpdate\getDatabaseConnection(), TYPO3\CMS\Core\Utility\ExtensionManagementUtility\isLoaded(), TYPO3\CMS\Install\Updates\AbstractUpdate\isWizardDone(), and TYPO3\CMS\Install\Updates\AbstractUpdate\markWizardAsDone().

mapSettings()

TYPO3\CMS\Install\Updates\WorkspacesNotificationSettingsUpdate::mapSettings ( array  $record, array  $update,   $from = '',   $to = ''  )

protected

Maps settings to new meaning.

Parameters

array	$record
array	$update
string	$from
string	$to

Returns

array

Definition at line 147 of file WorkspacesNotificationSettingsUpdate.php.

Referenced by TYPO3\CMS\Install\Updates\WorkspacesNotificationSettingsUpdate\prepareStageUpdate(), and TYPO3\CMS\Install\Updates\WorkspacesNotificationSettingsUpdate\prepareWorkspaceUpdate().

performUpdate()

TYPO3\CMS\Install\Updates\WorkspacesNotificationSettingsUpdate::performUpdate	(	array &	$databaseQueries,
		&	$customMessages
	)

Perform the database updates for workspace records

Parameters

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

Returns

bool

Definition at line 76 of file WorkspacesNotificationSettingsUpdate.php.

References TYPO3\CMS\Install\Updates\AbstractUpdate\getDatabaseConnection(), TYPO3\CMS\Install\Updates\AbstractUpdate\markWizardAsDone(), TYPO3\CMS\Install\Updates\WorkspacesNotificationSettingsUpdate\prepareStageUpdate(), and TYPO3\CMS\Install\Updates\WorkspacesNotificationSettingsUpdate\prepareWorkspaceUpdate().

prepareStageUpdate()

TYPO3\CMS\Install\Updates\WorkspacesNotificationSettingsUpdate::prepareStageUpdate ( array  $stageRecord )

protected

Prepares SQL update for stage records.

Parameters

array

$stageRecord

Returns

array|null

Definition at line 127 of file WorkspacesNotificationSettingsUpdate.php.

References TYPO3\CMS\Install\Updates\WorkspacesNotificationSettingsUpdate\mapSettings().

Referenced by TYPO3\CMS\Install\Updates\WorkspacesNotificationSettingsUpdate\performUpdate().

prepareWorkspaceUpdate()

TYPO3\CMS\Install\Updates\WorkspacesNotificationSettingsUpdate::prepareWorkspaceUpdate ( array  $workspaceRecord )

protected

Prepares SQL updates for workspace records.

Parameters

array

$workspaceRecord

Returns

array|NULL

Definition at line 108 of file WorkspacesNotificationSettingsUpdate.php.

References TYPO3\CMS\Install\Updates\WorkspacesNotificationSettingsUpdate\mapSettings().

Referenced by TYPO3\CMS\Install\Updates\WorkspacesNotificationSettingsUpdate\performUpdate().

Member Data Documentation

$title

TYPO3\CMS\Install\Updates\WorkspacesNotificationSettingsUpdate::$title = 'Migrate the workspaces notification settings to the enhanced schema'

protected

Definition at line 27 of file WorkspacesNotificationSettingsUpdate.php.