TYPO3\CMS\Backend\Module\ModuleData Class Reference

Public Member Functions
	__construct (string $moduleIdentifier, array $data, array $defaultData=[])
	getModuleIdentifier ()
	get (string $propertyName, mixed $default=null)
	has (string $propertyName)
	set (string $propertyName, mixed $value)
bool	clean (string $propertyName, array $allowedValues)
	cleanUp (array $allowedData, bool $useKeys=true)
	toArray ()

Static Public Member Functions
static	createFromModule (ModuleInterface $module, array $data)

Protected Attributes
array	$properties = []
string	$moduleIdentifier
array	$defaultData = []

Detailed Description

A simple DTO containing the user specific module settings, e.g. whether the clipboard is shown. The DTO is created in the PSR-15 middleware BackendModuleValidator, in case a backend module is requested and the user has necessary access permissions. The created DTO is then added as attribute to the PSR-7 Request and can be further used in components, such as middlewares or the route target (usually a backend controller).

See also

‪BackendModuleValidator

Definition at line 29 of file ModuleData.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Backend\Module\ModuleData::__construct	(	string	$moduleIdentifier,
		array	$data,
		array	$defaultData = []
	)

Definition at line 35 of file ModuleData.php.

References TYPO3\CMS\Backend\Module\ModuleData\$defaultData, and TYPO3\CMS\Backend\Module\ModuleData\$moduleIdentifier.

Member Function Documentation

clean()

bool TYPO3\CMS\Backend\Module\ModuleData::clean	(	string	$propertyName,
		array	$allowedValues
	)

Cleans a single property by the given allowed list. First fallback is the default data list. If this list does also not contain an allowed value, the first value from the allowed list is taken.

Returns

‪bool True if something has been cleaned up

Definition at line 78 of file ModuleData.php.

References TYPO3\CMS\Backend\Module\ModuleData\has().

Referenced by TYPO3\CMS\Backend\Module\ModuleData\cleanUp().

cleanUp()

TYPO3\CMS\Backend\Module\ModuleData::cleanUp	(	array	$allowedData,
		bool	$useKeys = true
	)

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

Definition at line 108 of file ModuleData.php.

References TYPO3\CMS\Backend\Module\ModuleData\clean(), and TYPO3\CMS\Backend\Module\ModuleData\has().

createFromModule()

static TYPO3\CMS\Backend\Module\ModuleData::createFromModule ( ModuleInterface  $module, array  $data  )

static

Definition at line 42 of file ModuleData.php.

References TYPO3\CMS\Backend\Module\ModuleInterface\getDefaultModuleData(), and TYPO3\CMS\Backend\Module\ModuleInterface\getIdentifier().

Referenced by TYPO3\CMS\Backend\Tests\Functional\Module\ModuleDataTest\moduleDataAreCreatedFromModule(), and TYPO3\CMS\Backend\Middleware\BackendModuleValidator\process().

get()

TYPO3\CMS\Backend\Module\ModuleData::get	(	string	$propertyName,
		mixed	$default = null
	)

Definition at line 56 of file ModuleData.php.

Referenced by TYPO3\CMS\Tstemplate\Controller\TemplateAnalyzerController\handleToggledConstantConditions(), TYPO3\CMS\Tstemplate\Controller\ActiveTypoScriptController\handleToggledConstantConditions(), TYPO3\CMS\Backend\Controller\PageTsConfig\PageTsConfigActiveController\handleToggledPageTsConfigConditions(), TYPO3\CMS\Backend\Controller\PageTsConfig\PageTsConfigIncludesController\handleToggledPageTsConfigConditions(), TYPO3\CMS\Tstemplate\Controller\TemplateAnalyzerController\handleToggledSetupConditions(), TYPO3\CMS\Tstemplate\Controller\ActiveTypoScriptController\handleToggledSetupConditions(), TYPO3\CMS\Beuser\Controller\BackendUserController\processRequest(), and TYPO3\CMS\Scheduler\Controller\SchedulerModuleController\renderListTasksView().

getModuleIdentifier()

TYPO3\CMS\Backend\Module\ModuleData::getModuleIdentifier

(

)

Definition at line 51 of file ModuleData.php.

References TYPO3\CMS\Backend\Module\ModuleData\$moduleIdentifier.

Referenced by TYPO3\CMS\Tstemplate\Controller\TemplateAnalyzerController\handleToggledConstantConditions(), TYPO3\CMS\Tstemplate\Controller\ActiveTypoScriptController\handleToggledConstantConditions(), TYPO3\CMS\Backend\Controller\PageTsConfig\PageTsConfigActiveController\handleToggledPageTsConfigConditions(), TYPO3\CMS\Backend\Controller\PageTsConfig\PageTsConfigIncludesController\handleToggledPageTsConfigConditions(), TYPO3\CMS\Tstemplate\Controller\TemplateAnalyzerController\handleToggledSetupConditions(), TYPO3\CMS\Tstemplate\Controller\ActiveTypoScriptController\handleToggledSetupConditions(), and TYPO3\CMS\Beuser\Controller\BackendUserController\processRequest().

has()

TYPO3\CMS\Backend\Module\ModuleData::has

(

string

$propertyName

)

Definition at line 61 of file ModuleData.php.

Referenced by TYPO3\CMS\Backend\Module\ModuleData\clean(), TYPO3\CMS\Backend\Module\ModuleData\cleanUp(), and TYPO3\CMS\Beuser\Controller\BackendUserController\processRequest().

set()

TYPO3\CMS\Backend\Module\ModuleData::set	(	string	$propertyName,
		mixed	$value
	)

Definition at line 66 of file ModuleData.php.

Referenced by TYPO3\CMS\Tstemplate\Controller\TemplateAnalyzerController\handleToggledConstantConditions(), TYPO3\CMS\Tstemplate\Controller\ActiveTypoScriptController\handleToggledConstantConditions(), TYPO3\CMS\Backend\Controller\PageTsConfig\PageTsConfigActiveController\handleToggledPageTsConfigConditions(), TYPO3\CMS\Backend\Controller\PageTsConfig\PageTsConfigIncludesController\handleToggledPageTsConfigConditions(), TYPO3\CMS\Tstemplate\Controller\TemplateAnalyzerController\handleToggledSetupConditions(), TYPO3\CMS\Tstemplate\Controller\ActiveTypoScriptController\handleToggledSetupConditions(), and TYPO3\CMS\Beuser\Controller\BackendUserController\processRequest().

toArray()

TYPO3\CMS\Backend\Module\ModuleData::toArray

(

)

Definition at line 122 of file ModuleData.php.

References TYPO3\CMS\Backend\Module\ModuleData\$properties.

Referenced by TYPO3\CMS\Tstemplate\Controller\TemplateAnalyzerController\handleToggledConstantConditions(), TYPO3\CMS\Tstemplate\Controller\ActiveTypoScriptController\handleToggledConstantConditions(), TYPO3\CMS\Backend\Controller\PageTsConfig\PageTsConfigActiveController\handleToggledPageTsConfigConditions(), TYPO3\CMS\Backend\Controller\PageTsConfig\PageTsConfigIncludesController\handleToggledPageTsConfigConditions(), TYPO3\CMS\Tstemplate\Controller\TemplateAnalyzerController\handleToggledSetupConditions(), TYPO3\CMS\Tstemplate\Controller\ActiveTypoScriptController\handleToggledSetupConditions(), and TYPO3\CMS\Beuser\Controller\BackendUserController\processRequest().

Member Data Documentation

$defaultData

array TYPO3\CMS\Backend\Module\ModuleData::$defaultData = []

protected

Definition at line 33 of file ModuleData.php.

Referenced by TYPO3\CMS\Backend\Module\ModuleData\__construct().

$moduleIdentifier

string TYPO3\CMS\Backend\Module\ModuleData::$moduleIdentifier

protected

Definition at line 32 of file ModuleData.php.

Referenced by TYPO3\CMS\Backend\Module\ModuleData\__construct(), and TYPO3\CMS\Backend\Module\ModuleData\getModuleIdentifier().

$properties

array TYPO3\CMS\Backend\Module\ModuleData::$properties = []

protected

Definition at line 31 of file ModuleData.php.

Referenced by TYPO3\CMS\Backend\Module\ModuleData\toArray().