TYPO3\CMS\Install\Updates\BackendLayoutIconUpdateWizard Class Reference

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

Public Member Functions
string	getIdentifier ()
string	getTitle ()
string	getDescription ()
bool	updateNecessary ()
string[]	getPrerequisites ()
	setOutput (OutputInterface $output)
bool	executeUpdate ()

Protected Member Functions
array	getRecordsFromTable ()
	migrateField ($row)

Protected Attributes
OutputInterface	$output
ResourceStorage	$storage
string	$table = 'backend_layout'
string	$fieldToMigrate = 'icon'
string	$sourcePath = 'uploads/media/'
string	$targetPath = '_migrated/backend_layouts/'

Detailed Description

Upgrade wizard which goes through all files referenced in backend_layout.icon and creates sys_file records as well as sys_file_reference records for each hit.

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

Definition at line 38 of file BackendLayoutIconUpdateWizard.php.

Member Function Documentation

executeUpdate()

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

(

)

Performs the configuration update.

Returns

‪bool

Implements TYPO3\CMS\Install\Updates\UpgradeWizardInterface.

Definition at line 132 of file BackendLayoutIconUpdateWizard.php.

References TYPO3\CMS\Install\Updates\BackendLayoutIconUpdateWizard\getRecordsFromTable(), and TYPO3\CMS\Install\Updates\BackendLayoutIconUpdateWizard\migrateField().

getDescription()

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

(

)

Returns

‪string Longer description of this updater

Implements TYPO3\CMS\Install\Updates\UpgradeWizardInterface.

Definition at line 94 of file BackendLayoutIconUpdateWizard.php.

getIdentifier()

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

(

)

Returns

‪string Unique identifier of this updater

Implements TYPO3\CMS\Install\Updates\UpgradeWizardInterface.

Definition at line 78 of file BackendLayoutIconUpdateWizard.php.

getPrerequisites()

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

(

)

Returns

‪string[] All new fields and tables must exist

Implements TYPO3\CMS\Install\Updates\UpgradeWizardInterface.

Definition at line 112 of file BackendLayoutIconUpdateWizard.php.

getRecordsFromTable()

array TYPO3\CMS\Install\Updates\BackendLayoutIconUpdateWizard::getRecordsFromTable ( )

protected

Get records from table where the field to migrate is not empty (NOT NULL and != '') and also not numeric (which means that it is migrated)

Returns

‪array

Exceptions

Definition at line 156 of file BackendLayoutIconUpdateWizard.php.

References TYPO3\CMS\Core\Database\Query\Expression\ExpressionBuilder\NEQ.

Referenced by TYPO3\CMS\Install\Updates\BackendLayoutIconUpdateWizard\executeUpdate(), and TYPO3\CMS\Install\Updates\BackendLayoutIconUpdateWizard\updateNecessary().

getTitle()

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

(

)

Returns

‪string Title of this updater

Implements TYPO3\CMS\Install\Updates\UpgradeWizardInterface.

Definition at line 86 of file BackendLayoutIconUpdateWizard.php.

migrateField()

TYPO3\CMS\Install\Updates\BackendLayoutIconUpdateWizard::migrateField (   $row )

protected

Migrates a single field.

Parameters

array

$row

Exceptions

Definition at line 194 of file BackendLayoutIconUpdateWizard.php.

References $fields, TYPO3\CMS\Install\Updates\BackendLayoutIconUpdateWizard\$fieldToMigrate, $GLOBALS, TYPO3\CMS\Install\Updates\BackendLayoutIconUpdateWizard\$sourcePath, TYPO3\CMS\Install\Updates\BackendLayoutIconUpdateWizard\$table, TYPO3\CMS\Install\Updates\BackendLayoutIconUpdateWizard\$targetPath, TYPO3\CMS\Core\Utility\PathUtility\basenameDuringBootstrap(), TYPO3\CMS\Core\Core\Environment\getPublicPath(), TYPO3\CMS\Core\Utility\GeneralUtility\mkdir_deep(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

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

setOutput()

TYPO3\CMS\Install\Updates\BackendLayoutIconUpdateWizard::setOutput

(

OutputInterface

$output

)

Parameters

OutputInterface

$output

Implements TYPO3\CMS\Install\Updates\ChattyInterface.

Definition at line 122 of file BackendLayoutIconUpdateWizard.php.

References TYPO3\CMS\Install\Updates\BackendLayoutIconUpdateWizard\$output.

updateNecessary()

bool TYPO3\CMS\Install\Updates\BackendLayoutIconUpdateWizard::updateNecessary

(

)

Returns

‪bool True if there are records to update

Implements TYPO3\CMS\Install\Updates\UpgradeWizardInterface.

Definition at line 104 of file BackendLayoutIconUpdateWizard.php.

References TYPO3\CMS\Install\Updates\BackendLayoutIconUpdateWizard\getRecordsFromTable().

Member Data Documentation

$fieldToMigrate

string TYPO3\CMS\Install\Updates\BackendLayoutIconUpdateWizard::$fieldToMigrate = 'icon'

protected

Table field holding the migration to be

Definition at line 60 of file BackendLayoutIconUpdateWizard.php.

Referenced by TYPO3\CMS\Install\Updates\BackendLayoutIconUpdateWizard\migrateField().

$output

OutputInterface TYPO3\CMS\Install\Updates\BackendLayoutIconUpdateWizard::$output

protected

Definition at line 44 of file BackendLayoutIconUpdateWizard.php.

Referenced by TYPO3\CMS\Install\Updates\BackendLayoutIconUpdateWizard\setOutput().

$sourcePath

string TYPO3\CMS\Install\Updates\BackendLayoutIconUpdateWizard::$sourcePath = 'uploads/media/'

protected

the source file resides here

Definition at line 66 of file BackendLayoutIconUpdateWizard.php.

Referenced by TYPO3\CMS\Install\Updates\BackendLayoutIconUpdateWizard\migrateField().

$storage

ResourceStorage TYPO3\CMS\Install\Updates\BackendLayoutIconUpdateWizard::$storage

protected

Definition at line 48 of file BackendLayoutIconUpdateWizard.php.

$table

string TYPO3\CMS\Install\Updates\BackendLayoutIconUpdateWizard::$table = 'backend_layout'

protected

Table to migrate records from

Definition at line 54 of file BackendLayoutIconUpdateWizard.php.

Referenced by TYPO3\CMS\Install\Updates\BackendLayoutIconUpdateWizard\migrateField().

$targetPath

string TYPO3\CMS\Install\Updates\BackendLayoutIconUpdateWizard::$targetPath = '_migrated/backend_layouts/'

protected

target folder after migration Relative to fileadmin

Definition at line 73 of file BackendLayoutIconUpdateWizard.php.

Referenced by TYPO3\CMS\Install\Updates\BackendLayoutIconUpdateWizard\migrateField().