FileFormsToDatabaseUpgradeWizard implements UpgradeWizardInterface, ConfirmableInterface
Migrate file-based form definitions (YAML) to database storage.
This wizard uses the FormTransferService to read all form definitions from the configured file mount storage, imports them into the form_definition database table, and updates all tt_content references (FlexForm persistenceIdentifier) to point to the new database records.
After successful migration, the original YAML files are deleted from file storage to avoid duplicates.
Tags
Attributes
- #[UpgradeWizard]
- 'formFileFormsToDatabaseMigration'
Table of Contents
Interfaces
- UpgradeWizardInterface
- Interface UpgradeWizardInterface
- ConfirmableInterface
- Use if upgrade wizard needs confirmation
Methods
- __construct() : mixed
- executeUpdate() : bool
- Execute the update
- getConfirmation() : Confirmation
- Return a confirmation message instance
- 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
- Is an update necessary?
Methods
__construct()
public
__construct(FormDefinitionRepository $formDefinitionRepository, FormTransferService $formTransferService, LoggerInterface $logger) : mixed
Parameters
- $formDefinitionRepository : FormDefinitionRepository
- $formTransferService : FormTransferService
- $logger : LoggerInterface
executeUpdate()
Execute the update
public
executeUpdate() : bool
Called when a wizard reports that an update is necessary
Return values
boolgetConfirmation()
Return a confirmation message instance
public
getConfirmation() : Confirmation
Return values
ConfirmationgetDescription()
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()
Is an update necessary?
public
updateNecessary() : bool
Is used to determine whether a wizard needs to be run. Check if data for migration exists.