TYPO3\CMS\Install\Updates\ShortcutRecordsMigration Class Reference

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

Public Member Functions
	getIdentifier ()
	getTitle ()
	getDescription ()
	getPrerequisites ()
	updateNecessary ()
	executeUpdate ()

Protected Member Functions
	columnsExistInTable ()
	hasRecordsToUpdate ()
	getRecordsToUpdate ()
	getPreparedQueryBuilder ()
	getRouteIdentifierForModuleName (string $moduleName)
	getConnectionPool ()

Protected Attributes
iterable	$routes = null

Private Attributes
const	TABLE_NAME = 'sys_be_shortcuts'

Detailed Description

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

Definition at line 28 of file ShortcutRecordsMigration.php.

Member Function Documentation

columnsExistInTable()

TYPO3\CMS\Install\Updates\ShortcutRecordsMigration::columnsExistInTable ( )

protected

Definition at line 103 of file ShortcutRecordsMigration.php.

References TYPO3\CMS\Install\Updates\ShortcutRecordsMigration\getConnectionPool().

Referenced by TYPO3\CMS\Install\Updates\ShortcutRecordsMigration\updateNecessary().

executeUpdate()

TYPO3\CMS\Install\Updates\ShortcutRecordsMigration::executeUpdate

(

)

Execute the update

Called when a wizard reports that an update is necessary

Returns

‪bool

Implements TYPO3\CMS\Install\Updates\UpgradeWizardInterface.

Definition at line 61 of file ShortcutRecordsMigration.php.

References TYPO3\CMS\Install\Updates\ShortcutRecordsMigration\getConnectionPool(), TYPO3\CMS\Install\Updates\ShortcutRecordsMigration\getRecordsToUpdate(), and TYPO3\CMS\Install\Updates\ShortcutRecordsMigration\getRouteIdentifierForModuleName().

getConnectionPool()

TYPO3\CMS\Install\Updates\ShortcutRecordsMigration::getConnectionPool ( )

protected

Definition at line 183 of file ShortcutRecordsMigration.php.

Referenced by TYPO3\CMS\Install\Updates\ShortcutRecordsMigration\columnsExistInTable(), TYPO3\CMS\Install\Updates\ShortcutRecordsMigration\executeUpdate(), and TYPO3\CMS\Install\Updates\ShortcutRecordsMigration\getPreparedQueryBuilder().

getDescription()

TYPO3\CMS\Install\Updates\ShortcutRecordsMigration::getDescription

(

)

Return the description for this wizard

Returns

‪string

Implements TYPO3\CMS\Install\Updates\UpgradeWizardInterface.

Definition at line 44 of file ShortcutRecordsMigration.php.

getIdentifier()

TYPO3\CMS\Install\Updates\ShortcutRecordsMigration::getIdentifier

(

)

Return the identifier for this wizard This should be the same string as used in the ext_localconf class registration

Returns

‪string

Implements TYPO3\CMS\Install\Updates\UpgradeWizardInterface.

Definition at line 34 of file ShortcutRecordsMigration.php.

getPreparedQueryBuilder()

TYPO3\CMS\Install\Updates\ShortcutRecordsMigration::getPreparedQueryBuilder ( )

protected

Definition at line 128 of file ShortcutRecordsMigration.php.

References TYPO3\CMS\Install\Updates\ShortcutRecordsMigration\getConnectionPool().

Referenced by TYPO3\CMS\Install\Updates\ShortcutRecordsMigration\getRecordsToUpdate(), and TYPO3\CMS\Install\Updates\ShortcutRecordsMigration\hasRecordsToUpdate().

getPrerequisites()

TYPO3\CMS\Install\Updates\ShortcutRecordsMigration::getPrerequisites

(

)

Returns an array of class names of Prerequisite classes

This way a wizard can define dependencies like "database up-to-date" or "reference index updated"

Returns

‪string[]

Implements TYPO3\CMS\Install\Updates\UpgradeWizardInterface.

Definition at line 49 of file ShortcutRecordsMigration.php.

getRecordsToUpdate()

TYPO3\CMS\Install\Updates\ShortcutRecordsMigration::getRecordsToUpdate ( )

protected

Definition at line 123 of file ShortcutRecordsMigration.php.

References TYPO3\CMS\Install\Updates\ShortcutRecordsMigration\getPreparedQueryBuilder().

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

getRouteIdentifierForModuleName()

TYPO3\CMS\Install\Updates\ShortcutRecordsMigration::getRouteIdentifierForModuleName ( string  $moduleName )

protected

Definition at line 150 of file ShortcutRecordsMigration.php.

References $GLOBALS.

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

getTitle()

TYPO3\CMS\Install\Updates\ShortcutRecordsMigration::getTitle

(

)

Return the speaking name of this wizard

Returns

‪string

Implements TYPO3\CMS\Install\Updates\UpgradeWizardInterface.

Definition at line 39 of file ShortcutRecordsMigration.php.

hasRecordsToUpdate()

TYPO3\CMS\Install\Updates\ShortcutRecordsMigration::hasRecordsToUpdate ( )

protected

Definition at line 118 of file ShortcutRecordsMigration.php.

References TYPO3\CMS\Install\Updates\ShortcutRecordsMigration\getPreparedQueryBuilder().

Referenced by TYPO3\CMS\Install\Updates\ShortcutRecordsMigration\updateNecessary().

updateNecessary()

TYPO3\CMS\Install\Updates\ShortcutRecordsMigration::updateNecessary

(

)

Is an update necessary?

Is used to determine whether a wizard needs to be run. Check if data for migration exists.

Returns

‪bool

Implements TYPO3\CMS\Install\Updates\UpgradeWizardInterface.

Definition at line 56 of file ShortcutRecordsMigration.php.

References TYPO3\CMS\Install\Updates\ShortcutRecordsMigration\columnsExistInTable(), and TYPO3\CMS\Install\Updates\ShortcutRecordsMigration\hasRecordsToUpdate().

Member Data Documentation

$routes

iterable TYPO3\CMS\Install\Updates\ShortcutRecordsMigration::$routes = null

protected

Definition at line 32 of file ShortcutRecordsMigration.php.

TABLE_NAME

const TYPO3\CMS\Install\Updates\ShortcutRecordsMigration::TABLE_NAME = 'sys_be_shortcuts'

private

Definition at line 30 of file ShortcutRecordsMigration.php.