SysNoteDashboardWidgetDatabaseMigration

class \TYPO3\CMS\SysNote\Migration\SysNoteDashboardWidgetDatabaseMigration

Implements
UpgradeWizardInterface

Migration wizard for updating System Note dashboard widgets to configurable variants.

This upgrade wizard migrates existing System Note dashboard widgets from the legacy implementation to the new configurable widget format introduced in TYPO3 v14.0. It updates widget configurations in the database to use the new widget renderer interface with per-instance settings support.

The migration ensures that existing dashboard configurations continue to work while enabling the new configuration capabilities for System Note widgets.

Tags

since
14.0

Attributes

#[UpgradeWizard]
'sysNoteDashboardWidgetDatabaseMigration'

Table of Contents

Interfaces

UpgradeWizardInterface
Interface UpgradeWizardInterface

Constants

TABLE_NAME  : mixed = 'be_dashboards'

Methods

executeUpdate()  : bool
Execute the update
getDescription()  : string
Return the description for this wizard
getPrerequisites()  : 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?
getConnectionPool()  : ConnectionPool
getPreparedQueryBuilder()  : QueryBuilder
getRecordsToUpdate()  : array
getWidgetMappig()  : array<string, array{identifier: string, settings: array{category: string}}>
hasRecordsToUpdate()  : bool

Constants

TABLE_NAME

protected mixed TABLE_NAME = 'be_dashboards'

Methods

executeUpdate()

Execute the update

public executeUpdate() : bool

Called when a wizard reports that an update is necessary

Return values

bool

getDescription()

Return the description for this wizard

public getDescription() : string

Return values

string

getPrerequisites()

Returns an array of class names of Prerequisite classes

public getPrerequisites() : string[]

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

Return values

string[]

getTitle()

Return the speaking name of this wizard

public getTitle() : string

Return values

string

updateNecessary()

Is an update necessary?

public updateNecessary() : bool

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

Return values

bool

getRecordsToUpdate()

protected getRecordsToUpdate() : array

Return values

array

getWidgetMappig()

protected getWidgetMappig() : array<string, array{identifier: string, settings: array{category: string}}>

Return values

array<string, array{identifier: string, settings: array{category: string}}>

hasRecordsToUpdate()

protected hasRecordsToUpdate() : bool

Return values

bool
On this page