TYPO3\CMS\Install\Updates\MigrateSiteSettingsConfigUpdate Class Reference

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

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

Protected Member Functions
	getSitePathsToMigrate ()

Protected Attributes
const	SETTINGS_FILENAME = 'settings.yaml'
SiteConfiguration	$siteConfiguration = null
SiteWriter	$siteWriter = null
array	$sitePathsToMigrate = []

Detailed Description

Since

12.1

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

The upgrade wizard cuts the settings part of the config.yaml and moves it into settings.yaml.

Definition at line 33 of file MigrateSiteSettingsConfigUpdate.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Install\Updates\MigrateSiteSettingsConfigUpdate::__construct

(

)

Definition at line 41 of file MigrateSiteSettingsConfigUpdate.php.

References TYPO3\CMS\Install\Updates\MigrateSiteSettingsConfigUpdate\getSitePathsToMigrate().

Member Function Documentation

executeUpdate()

TYPO3\CMS\Install\Updates\MigrateSiteSettingsConfigUpdate::executeUpdate

(

)

Execute the update

Called when a wizard reports that an update is necessary

Implements TYPO3\CMS\Install\Updates\UpgradeWizardInterface.

Definition at line 60 of file MigrateSiteSettingsConfigUpdate.php.

References TYPO3\CMS\Webhooks\Message\$siteIdentifier.

getDescription()

TYPO3\CMS\Install\Updates\MigrateSiteSettingsConfigUpdate::getDescription

(

)

Return the description for this wizard

Implements TYPO3\CMS\Install\Updates\UpgradeWizardInterface.

Definition at line 53 of file MigrateSiteSettingsConfigUpdate.php.

getPrerequisites()

TYPO3\CMS\Install\Updates\MigrateSiteSettingsConfigUpdate::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 80 of file MigrateSiteSettingsConfigUpdate.php.

getSitePathsToMigrate()

TYPO3\CMS\Install\Updates\MigrateSiteSettingsConfigUpdate::getSitePathsToMigrate ( )

protected

returns an array of siteconfigs, if they don't have a corresponding settings file

Definition at line 88 of file MigrateSiteSettingsConfigUpdate.php.

References TYPO3\CMS\Install\Updates\MigrateSiteSettingsConfigUpdate\$siteConfiguration, TYPO3\CMS\Webhooks\Message\$siteIdentifier, and TYPO3\CMS\Core\Configuration\SiteConfiguration\load().

Referenced by TYPO3\CMS\Install\Updates\MigrateSiteSettingsConfigUpdate\__construct().

getTitle()

TYPO3\CMS\Install\Updates\MigrateSiteSettingsConfigUpdate::getTitle

(

)

Return the speaking name of this wizard

Implements TYPO3\CMS\Install\Updates\UpgradeWizardInterface.

Definition at line 48 of file MigrateSiteSettingsConfigUpdate.php.

updateNecessary()

TYPO3\CMS\Install\Updates\MigrateSiteSettingsConfigUpdate::updateNecessary

(

)

if the settings file does not exist an update is considered as necessary

Implements TYPO3\CMS\Install\Updates\UpgradeWizardInterface.

Definition at line 75 of file MigrateSiteSettingsConfigUpdate.php.

Member Data Documentation

$siteConfiguration

SiteConfiguration TYPO3\CMS\Install\Updates\MigrateSiteSettingsConfigUpdate::$siteConfiguration = null

protected

Definition at line 37 of file MigrateSiteSettingsConfigUpdate.php.

Referenced by TYPO3\CMS\Install\Updates\MigrateSiteSettingsConfigUpdate\getSitePathsToMigrate().

$sitePathsToMigrate

array TYPO3\CMS\Install\Updates\MigrateSiteSettingsConfigUpdate::$sitePathsToMigrate = []

protected

Definition at line 39 of file MigrateSiteSettingsConfigUpdate.php.

$siteWriter

SiteWriter TYPO3\CMS\Install\Updates\MigrateSiteSettingsConfigUpdate::$siteWriter = null

protected

Definition at line 38 of file MigrateSiteSettingsConfigUpdate.php.

SETTINGS_FILENAME

const TYPO3\CMS\Install\Updates\MigrateSiteSettingsConfigUpdate::SETTINGS_FILENAME = 'settings.yaml'

protected

Definition at line 35 of file MigrateSiteSettingsConfigUpdate.php.