DeprecatedRteProperties Class Reference

Inheritance diagram for DeprecatedRteProperties:

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 = 'Deprecated RTE properties in Page TSconfig'
	$replacementRteProperties
	$doubleReplacementRteProperties
	$useInsteadRteProperties
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 RTE properties in Page TSconfig. Used by the upgrade wizard in the install tool.

Definition at line 23 of file DeprecatedRteProperties.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 101 of file DeprecatedRteProperties.php.

References DeprecatedRteProperties\findUpdateablePagesWithDeprecatedRteProperties(), DeprecatedRteProperties\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 232 of file DeprecatedRteProperties.php.

Referenced by DeprecatedRteProperties\checkForUpdate(), and DeprecatedRteProperties\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 205 of file DeprecatedRteProperties.php.

References AbstractUpdate\getDatabaseConnection().

Referenced by DeprecatedRteProperties\checkForUpdate(), and DeprecatedRteProperties\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 165 of file DeprecatedRteProperties.php.

References DeprecatedRteProperties\findUpdateablePagesWithDeprecatedRteProperties(), DeprecatedRteProperties\getPagesWithDeprecatedRteProperties(), AbstractUpdate\markWizardAsDone(), and DeprecatedRteProperties\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 254 of file DeprecatedRteProperties.php.

References AbstractUpdate\getDatabaseConnection().

Referenced by DeprecatedRteProperties\performUpdate().

Member Data Documentation

$doubleReplacementRteProperties

protected

Initial value:

= array(
        'disableTYPO3Browsers' => array(
            'buttons.image.TYPO3Browser.disabled',
            'buttons.link.TYPO3Browser.disabled'
        ),
        'showTagFreeClasses' => array(
            'buttons.blockstyle.showTagFreeClasses',
            'buttons.textstyle.showTagFreeClasses'
        ),
        'disablePCexamples' => array(
            'buttons.blockstyle.disableStyleOnOptionLabel',
            'buttons.textstyle.disableStyleOnOptionLabel'
        )
    )

Definition at line 60 of file DeprecatedRteProperties.php.

$replacementRteProperties

protected

Initial value:

= array(
        'disableRightClick' => 'contextMenu.disable',
        'disableContextMenu' => 'contextMenu.disable',
        'hidePStyleItems' => 'buttons.formatblock.removeItems',
        'hideFontFaces' => 'buttons.fontstyle.removeItems',
        'fontFace' => 'buttons.fontstyle.addItems',
        'hideFontSizes' => 'buttons.fontsize.removeItems',
        'classesCharacter' => 'buttons.textstyle.tags.span.allowedClasses',
        'classesParagraph' => 'buttons.blockstyle.tags.div.allowedClasses',
        'classesTable' => 'buttons.blockstyle.tags.table.allowedClasses',
        'classesTD' => 'buttons.blockstyle.tags.td.allowedClasses',
        'classesImage' => 'buttons.image.properties.class.allowedClasses',
        'classesLinks' => 'buttons.link.properties.class.allowedClasses',
        'blindImageOptions' => 'buttons.image.options.removeItems',
        'blindLinkOptions' => 'buttons.link.options.removeItems',
        'defaultLinkTarget' => 'buttons.link.properties.target.default'
    )

Definition at line 36 of file DeprecatedRteProperties.php.

$title = 'Deprecated RTE properties in Page TSconfig'

protected

Definition at line 28 of file DeprecatedRteProperties.php.

$useInsteadRteProperties

protected

Initial value:

= array(
        'fontSize' => 'buttons.fontsize.addItems',
        'RTE.default.classesAnchor' => 'RTE.default.buttons.link.properties.class.allowedClasses',
        'RTE.default.classesAnchor.default.[link-type]' => 'RTE.default.buttons.link.[link-type].properties.class.default',
        'mainStyleOverride' => 'contentCSS',
        'mainStyleOverride_add.[key]' => 'contentCSS',
        'mainStyle_font' => 'contentCSS',
        'mainStyle_size' => 'contentCSS',
        'mainStyle_color' => 'contentCSS',
        'mainStyle_bgcolor' => 'contentCSS',
        'inlineStyle.[any-keystring]' => 'contentCSS',
        'ignoreMainStyleOverride' => 'n.a.'
    )

Definition at line 81 of file DeprecatedRteProperties.php.