TYPO3\CMS\Adminpanel\Tests\Unit\Fixtures\MainModuleFixture Class Reference

Inheritance diagram for TYPO3\CMS\Adminpanel\Tests\Unit\Fixtures\MainModuleFixture:

Public Member Functions
string	getIdentifier ()
string	getLabel ()
string	getIconIdentifier ()
string	getShortInfo ()
string	getPageSettings ()
bool	isEnabled ()
	onSubmit (array $configurationToSave, ServerRequestInterface $request)
array	getJavaScriptFiles ()
array	getCssFiles ()
	setSubModules (array $subModules)
ModuleInterface[]	getSubModules ()
	hasSubmoduleSettings ()
ServerRequestInterface	enrich (ServerRequestInterface $request)

Detailed Description

Definition at line 30 of file MainModuleFixture.php.

Member Function Documentation

enrich()

ServerRequestInterface TYPO3\CMS\Adminpanel\Tests\Unit\Fixtures\MainModuleFixture::enrich

(

ServerRequestInterface

$request

)

Initialize the module - runs in the TYPO3 middleware stack at an early point may manipulate the current request

Parameters

ServerRequestInterface

$request

Returns

‪ServerRequestInterface

Implements TYPO3\CMS\Adminpanel\ModuleApi\RequestEnricherInterface.

Definition at line 165 of file MainModuleFixture.php.

getCssFiles()

array TYPO3\CMS\Adminpanel\Tests\Unit\Fixtures\MainModuleFixture::getCssFiles

(

)

Returns a string array with css files that will be rendered after the module

Returns

‪array

Implements TYPO3\CMS\Adminpanel\ModuleApi\ResourceProviderInterface.

Definition at line 128 of file MainModuleFixture.php.

getIconIdentifier()

string TYPO3\CMS\Adminpanel\Tests\Unit\Fixtures\MainModuleFixture::getIconIdentifier

(

)

Module Icon identifier - needs to be registered in iconRegistry

Returns

‪string

Implements TYPO3\CMS\Adminpanel\ModuleApi\ShortInfoProviderInterface.

Definition at line 66 of file MainModuleFixture.php.

getIdentifier()

string TYPO3\CMS\Adminpanel\Tests\Unit\Fixtures\MainModuleFixture::getIdentifier

(

)

Identifier for this module, for example "preview" or "cache"

Returns

‪string

Implements TYPO3\CMS\Adminpanel\ModuleApi\ModuleInterface.

Reimplemented in TYPO3\CMS\Adminpanel\Tests\Unit\Fixtures\DisabledMainModuleFixture.

Definition at line 46 of file MainModuleFixture.php.

getJavaScriptFiles()

array TYPO3\CMS\Adminpanel\Tests\Unit\Fixtures\MainModuleFixture::getJavaScriptFiles

(

)

Returns a string array with javascript files that will be rendered after the module

Returns

‪array

Implements TYPO3\CMS\Adminpanel\ModuleApi\ResourceProviderInterface.

Definition at line 118 of file MainModuleFixture.php.

getLabel()

string TYPO3\CMS\Adminpanel\Tests\Unit\Fixtures\MainModuleFixture::getLabel

(

)

Module label

Returns

‪string

Implements TYPO3\CMS\Adminpanel\ModuleApi\ModuleInterface.

Definition at line 56 of file MainModuleFixture.php.

getPageSettings()

string TYPO3\CMS\Adminpanel\Tests\Unit\Fixtures\MainModuleFixture::getPageSettings

(

)

Returns

‪string

Implements TYPO3\CMS\Adminpanel\ModuleApi\PageSettingsProviderInterface.

Definition at line 84 of file MainModuleFixture.php.

getShortInfo()

string TYPO3\CMS\Adminpanel\Tests\Unit\Fixtures\MainModuleFixture::getShortInfo

(

)

Displayed directly in the bar if module has content

Returns

‪string

Implements TYPO3\CMS\Adminpanel\ModuleApi\ShortInfoProviderInterface.

Definition at line 76 of file MainModuleFixture.php.

getSubModules()

ModuleInterface [] TYPO3\CMS\Adminpanel\Tests\Unit\Fixtures\MainModuleFixture::getSubModules

(

)

Get SubModules for current module

Returns

‪ModuleInterface[]

Implements TYPO3\CMS\Adminpanel\ModuleApi\SubmoduleProviderInterface.

Definition at line 145 of file MainModuleFixture.php.

hasSubmoduleSettings()

TYPO3\CMS\Adminpanel\Tests\Unit\Fixtures\MainModuleFixture::hasSubmoduleSettings

(

)

‪Return true if any of the submodules has settings to be rendered (can be used to render settings in a central place)

Returns

‪bool

Implements TYPO3\CMS\Adminpanel\ModuleApi\SubmoduleProviderInterface.

Definition at line 153 of file MainModuleFixture.php.

isEnabled()

bool TYPO3\CMS\Adminpanel\Tests\Unit\Fixtures\MainModuleFixture::isEnabled

(

)

Module is enabled -> should be initialized A module may be enabled but not shown -> only the initializeModule() method will be called

Returns

‪bool

Implements TYPO3\CMS\Adminpanel\ModuleApi\ConfigurableInterface.

Reimplemented in TYPO3\CMS\Adminpanel\Tests\Unit\Fixtures\DisabledMainModuleFixture.

Definition at line 98 of file MainModuleFixture.php.

onSubmit()

TYPO3\CMS\Adminpanel\Tests\Unit\Fixtures\MainModuleFixture::onSubmit	(	array	$configurationToSave,
		ServerRequestInterface	$request
	)

Executed on saving / submit of the configuration form Can be used to react to changed settings (for example: clearing a specific cache)

Parameters

array	$configurationToSave
ServerRequestInterface	$request

Implements TYPO3\CMS\Adminpanel\ModuleApi\OnSubmitActorInterface.

Definition at line 111 of file MainModuleFixture.php.

setSubModules()

TYPO3\CMS\Adminpanel\Tests\Unit\Fixtures\MainModuleFixture::setSubModules

(

array

$subModules

)

Set SubModules for current module

Parameters

ModuleInterface[]

$subModules

Implements TYPO3\CMS\Adminpanel\ModuleApi\SubmoduleProviderInterface.

Definition at line 138 of file MainModuleFixture.php.