Feature: #96895 - Introduce Module data object

See forge#96895

Description

To further improve the handling of TYPO3 backend modules, the module registration API, introduced in forge#96733, is extended by the new TYPO3\CMS\Backend\Module\ModuleData object.

The ModuleData object contains the user specific module settings, e.g. whether the clipboard is shown, for the requested module. Those settings are fetched from the users' session. A PSR-15 middleware does automatically create the object from the stored user data and attach it to the PSR-7 Request.

Through the module registration one can define, which properties can be overwritten via GET / POST and their default value.

The whole determination is done before the requested route target - usually a backend controller - is called. This means, the route target can just read the final module data and does no longer have to fiddle around with overwriting and persisting the data manually.

Previously, reading, overwriting and persisting of module data (settings) was done in the controller:

// Classes/Controller/MyController.php

$MOD_MENU = [
    'allowedProperty' => '',
    'anotherAllowedProperty' => true
];

$MOD_SETTINGS = BackendUtility::getModuleData(
    $MOD_MENU,
    $request->getParsedBody()['SET'] ?? $request->getQueryParams()['SET'] ?? [],
    'my_module'
);

This is now automatically done by a new PSR-15 middleware. The "allowed" properties are defined with their default value in the module registration:

// Configuration/Backend/Modules.php

'moduleData' => [
    'allowedProperty' => '',
    'anotherAllowedProperty' => true,
],

// Classes/Controller/MyController.php

$MOD_SETTINGS = $request->getAttribute('moduleData');

The ModuleData object provides the following methods:

Method

Parameters

Description

createFromModule()

$module $data

Create a new object for the given module, while overwriting the default values with $data.

getModuleIdentifier()

Returns the related module identifier

get()

$propertyName $default

Returns the value for $propertyName, or the $default, if not set.

set()

$propertyName $value

Updates $propertyName with the given $value.

has()

$propertyName

Whether $propertyName exists.

clean()

$propertyName $allowedValues

Cleans a single property by the given allowed list and falls back to either the default value or the first allowed value.

cleanUp()

$allowedData $useKeys

Cleans up all module data, which are defined in the given allowed data list. Usually called with $MOD_MENU in a controller with module menu.

toArray()

Returns the module data as array.

In case a controller needs to store changed module data, this can still be done using $backendUser->pushModuleData('my_module', $this->moduleData->toArray());.

Note

It's still possible to store and retrieve arbitrary module data. The definition of moduleData in the module registration only defines, which properties can be overwritten in a request (with GET / POST).

To restrict the values of module data properties, the given ModuleData object can be cleaned e.g. in a controller:

$allowedValues = ['foo', 'bar'];

$this->moduleData->clean('property', $allowedValues);

If ModuleData contains property, the value is checked against the $allowedValues list. If the current value is valid, nothing happens. Otherwise the value is either changed to the default or if this value is also not allowed, to the first allowed value.

Impact

The new ModuleData object is available as new attribute of the PSR-7 Request - in case a TYPO3 backend module is requested - and contains the stored module data, which might have been overwritten through the current request (with GET / POST).