LocalizationFinisherInterface

interface \TYPO3\CMS\Backend\Localization\Finisher\LocalizationFinisherInterface

Extends
JsonSerializable

Interface for finishers after localization

Finishers tell the frontend what to do after a successful localization, such as redirecting to a page, loading a JavaScript module, or executing custom logic.

Table of Contents

Methods

getData()  : array
Get the finisher data as an array
getIdentifier()  : string
Get the finisher type identifier
getLabels()  : array<string, string>
Get all labels needed by this finisher's JavaScript module
getModule()  : string
Get the JavaScript module path for this finisher

Methods

getData()

Get the finisher data as an array

public getData() : array

This data will be passed to the frontend handler

Return values

array

getIdentifier()

Get the finisher type identifier

public getIdentifier() : string

This is used by the frontend to determine which handler to use (e.g., 'redirect', 'noop', 'reload')

Return values

string

getLabels()

Get all labels needed by this finisher's JavaScript module

public getLabels() : array<string, string>

Implementations should provide pre-processed UI strings that will be passed through to the frontend without any server-side resolution. The finisher implementation is responsible for translating and formatting these strings.

The array should be a simple key-value map where keys are arbitrary identifiers used by the JavaScript module, and values are the ready-to-display strings.

Return values

array<string, string> —

Label identifier => Ready-to-display string

getModule()

Get the JavaScript module path for this finisher

public getModule() : string

This module will be dynamically loaded by the frontend to handle the finisher's rendering and execution logic.

Return values

string —

The module path (e.g., '@typo3/backend/localization/finisher/redirect-finisher.js')

On this page