RteAcronymButtonRenamedToAbbreviation Class Reference

Inheritance diagram for RteAcronymButtonRenamedToAbbreviation:

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

Protected Member Functions
	getPagesWithDeprecatedRteProperties (&$dbQueries, &$customMessages)
	findUpdateablePagesWithDeprecatedRteProperties (&$pages)
	updatePages ($pages, &$dbQueries, &$customMessages)
Protected Member Functions inherited from AbstractUpdate
	markWizardAsDone ($confValue=1)
	isWizardDone ()
	getDatabaseConnection ()

Protected Attributes
	$title = 'Rte "acronym" button renamed to "abbreviation"'
Protected Attributes inherited from AbstractUpdate
	$title
	$identifier

Additional Inherited Members
Public Attributes inherited from AbstractUpdate
	$pObj
	$userInput
	$versionNumber

Detailed Description

Contains the update class for the replacement of deprecated acronym button by abbreviation button in Page TSconfig. Used by the upgrade wizard in the install tool.

Definition at line 23 of file RteAcronymButtonRenamedToAbbreviation.php.

Member Function Documentation

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

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

Definition at line 36 of file RteAcronymButtonRenamedToAbbreviation.php.

References RteAcronymButtonRenamedToAbbreviation\findUpdateablePagesWithDeprecatedRteProperties(), RteAcronymButtonRenamedToAbbreviation\getPagesWithDeprecatedRteProperties(), and AbstractUpdate\isWizardDone().

findUpdateablePagesWithDeprecatedRteProperties ( &  $pages )

protected

Gets the pages with updateable deprecated RTE properties in TSconfig column

Parameters

array

$pages

reference to pages with deprecated property

Returns

array uid and inclusion string for the pages with deprecated RTE properties in TSconfig column

Definition at line 134 of file RteAcronymButtonRenamedToAbbreviation.php.

Referenced by RteAcronymButtonRenamedToAbbreviation\checkForUpdate(), and RteAcronymButtonRenamedToAbbreviation\performUpdate().

getPagesWithDeprecatedRteProperties ( &  $dbQueries, &  $customMessages  )

protected

Gets the pages with deprecated RTE properties in TSconfig column

Parameters

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

Returns

array uid and inclusion string for the pages with deprecated RTE properties in TSconfig column

Definition at line 110 of file RteAcronymButtonRenamedToAbbreviation.php.

References AbstractUpdate\getDatabaseConnection().

Referenced by RteAcronymButtonRenamedToAbbreviation\checkForUpdate(), and RteAcronymButtonRenamedToAbbreviation\performUpdate().

performUpdate	(	array &	$dbQueries,
		&	$customMessages
	)

Performs the update itself

Parameters

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

Returns

bool TRUE if update succeeded, FALSE otherwise

Definition at line 78 of file RteAcronymButtonRenamedToAbbreviation.php.

References RteAcronymButtonRenamedToAbbreviation\findUpdateablePagesWithDeprecatedRteProperties(), RteAcronymButtonRenamedToAbbreviation\getPagesWithDeprecatedRteProperties(), AbstractUpdate\markWizardAsDone(), and RteAcronymButtonRenamedToAbbreviation\updatePages().

updatePages (   $pages, &  $dbQueries, &  $customMessages  )

protected

updates the pages records with updateable Page TSconfig properties

Parameters

array	$pages	Page records to update, fetched by getTemplates() and filtered by
array	$dbQueries	Pointer where to insert all DB queries made, so they can be shown to the user if wanted
string	$customMessages	Pointer to output custom messages

Definition at line 154 of file RteAcronymButtonRenamedToAbbreviation.php.

References AbstractUpdate\getDatabaseConnection().

Referenced by RteAcronymButtonRenamedToAbbreviation\performUpdate().

Member Data Documentation

$title = 'Rte "acronym" button renamed to "abbreviation"'

protected

Definition at line 28 of file RteAcronymButtonRenamedToAbbreviation.php.