TYPO3\CMS\Install\Updates\SectionFrameToFrameClassUpdate Class Reference

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

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

Protected Member Functions
string	mapSectionFrame ($sectionFrame)

Detailed Description

Migrate the field 'section_frame' for all content elements to 'frame_class'

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

Definition at line 24 of file SectionFrameToFrameClassUpdate.php.

Member Function Documentation

executeUpdate()

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

(

)

Performs the database update

Returns

‪bool

Implements TYPO3\CMS\Install\Updates\UpgradeWizardInterface.

Definition at line 92 of file SectionFrameToFrameClassUpdate.php.

References TYPO3\CMS\Install\Updates\SectionFrameToFrameClassUpdate\mapSectionFrame().

getDescription()

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

(

)

Returns

‪string Longer description of this updater

Implements TYPO3\CMS\Install\Updates\UpgradeWizardInterface.

Definition at line 45 of file SectionFrameToFrameClassUpdate.php.

getIdentifier()

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

(

)

Returns

‪string Unique identifier of this updater

Implements TYPO3\CMS\Install\Updates\UpgradeWizardInterface.

Definition at line 29 of file SectionFrameToFrameClassUpdate.php.

getPrerequisites()

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

(

)

Returns

‪string[] All new fields and tables must exist

Implements TYPO3\CMS\Install\Updates\UpgradeWizardInterface.

Definition at line 80 of file SectionFrameToFrameClassUpdate.php.

getTitle()

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

(

)

Returns

‪string Title of this updater

Implements TYPO3\CMS\Install\Updates\UpgradeWizardInterface.

Definition at line 37 of file SectionFrameToFrameClassUpdate.php.

mapSectionFrame()

string TYPO3\CMS\Install\Updates\SectionFrameToFrameClassUpdate::mapSectionFrame (   $sectionFrame )

protected

Map the old to the new values

Parameters

int

$sectionFrame

‪The content of the FlexForm

Returns

‪string The equivalent value frame_class

Definition at line 125 of file SectionFrameToFrameClassUpdate.php.

Referenced by TYPO3\CMS\Install\Updates\SectionFrameToFrameClassUpdate\executeUpdate().

updateNecessary()

bool TYPO3\CMS\Install\Updates\SectionFrameToFrameClassUpdate::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 57 of file SectionFrameToFrameClassUpdate.php.