MigrateSiteSettingsConfigUpdate implements UpgradeWizardInterface
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.
Tags
Attributes
- #[UpgradeWizard]
- 'migrateSiteSettings'
Table of Contents
Interfaces
- UpgradeWizardInterface
- Interface UpgradeWizardInterface
Constants
- SETTINGS_FILENAME = 'settings.yaml'
Properties
- $siteConfiguration : SiteConfiguration|null
- $sitePathsToMigrate : array<string|int, mixed>
- $siteWriter : SiteWriter|null
Methods
- __construct() : mixed
- executeUpdate() : bool
- Execute the update
- getDescription() : string
- Return the description for this wizard
- getPrerequisites() : array<string|int, string>
- Returns an array of class names of Prerequisite classes
- getTitle() : string
- Return the speaking name of this wizard
- updateNecessary() : bool
- if the settings file does not exist an update is considered as necessary
- getSitePathsToMigrate() : array<string|int, mixed>
- returns an array of siteconfigs, if they don't have a corresponding settings file
Constants
SETTINGS_FILENAME
protected
mixed
SETTINGS_FILENAME
= 'settings.yaml'
Properties
$siteConfiguration
protected
SiteConfiguration|null
$siteConfiguration
= null
$sitePathsToMigrate
protected
array<string|int, mixed>
$sitePathsToMigrate
= []
$siteWriter
protected
SiteWriter|null
$siteWriter
= null
Methods
__construct()
public
__construct() : mixed
executeUpdate()
Execute the update
public
executeUpdate() : bool
Called when a wizard reports that an update is necessary
Return values
boolgetDescription()
Return the description for this wizard
public
getDescription() : string
Return values
stringgetPrerequisites()
Returns an array of class names of Prerequisite classes
public
getPrerequisites() : array<string|int, string>
This way a wizard can define dependencies like "database up-to-date" or "reference index updated"
Return values
array<string|int, string>getTitle()
Return the speaking name of this wizard
public
getTitle() : string
Return values
stringupdateNecessary()
if the settings file does not exist an update is considered as necessary
public
updateNecessary() : bool
Return values
boolgetSitePathsToMigrate()
returns an array of siteconfigs, if they don't have a corresponding settings file
protected
getSitePathsToMigrate() : array<string|int, mixed>