TYPO3\CMS\Adminpanel\Modules\PreviewModule Class Reference

Inheritance diagram for TYPO3\CMS\Adminpanel\Modules\PreviewModule:

Public Member Functions
	__construct (protected readonly CacheManager $cacheManager,)
	getIconIdentifier ()
	getIdentifier ()
	getLabel ()
	enrich (ServerRequestInterface $request)
	getPageSettings ()
	getJavaScriptFiles ()
	getCssFiles ()
	onSubmit (array $configurationToSave, ServerRequestInterface $request)
‪Public Member Functions inherited from ‪TYPO3\CMS\Adminpanel\ModuleApi\AbstractModule
	injectConfigurationService (ConfigurationService $configurationService)
	isEnabled ()
	setSubModules (array $subModules)
	getSubModules ()
	hasSubmoduleSettings ()
	setModuleData (ModuleDataStorageCollection $moduleData)

Protected Member Functions
	getConfigOptionForModule (string $option)
	initializeFrontendPreview (bool $showHiddenPages, bool $showHiddenRecords, bool $showScheduledRecords, int $simulateDate, int $simulateUserGroup, ServerRequestInterface $request)
	clearPreviewSettings (Context $context)
‪Protected Member Functions inherited from ‪TYPO3\CMS\Adminpanel\ModuleApi\AbstractModule
	getBackendUser ()
	getLanguageService ()
	isEnabledViaTsConfig ()

Protected Attributes
array	$config
‪Protected Attributes inherited from ‪TYPO3\CMS\Adminpanel\ModuleApi\AbstractModule
array	$subModules = []
array	$mainConfiguration
ConfigurationService	$configurationService
ModuleDataStorageCollection	$moduleData

Detailed Description

Admin Panel Preview Module

Definition at line 45 of file PreviewModule.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Adminpanel\Modules\PreviewModule::__construct

(

protected readonly CacheManager

$cacheManager

)

Definition at line 63 of file PreviewModule.php.

Member Function Documentation

clearPreviewSettings()

TYPO3\CMS\Adminpanel\Modules\PreviewModule::clearPreviewSettings ( Context  $context )

protected

Definition at line 232 of file PreviewModule.php.

References $GLOBALS, and TYPO3\CMS\Core\Context\Context\setAspect().

Referenced by TYPO3\CMS\Adminpanel\Modules\PreviewModule\initializeFrontendPreview().

enrich()

TYPO3\CMS\Adminpanel\Modules\PreviewModule::enrich

(

ServerRequestInterface

$request

)

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

Implements TYPO3\CMS\Adminpanel\ModuleApi\RequestEnricherInterface.

Definition at line 84 of file PreviewModule.php.

References $GLOBALS, TYPO3\CMS\Adminpanel\Modules\PreviewModule\getConfigOptionForModule(), and TYPO3\CMS\Adminpanel\Modules\PreviewModule\initializeFrontendPreview().

getConfigOptionForModule()

TYPO3\CMS\Adminpanel\Modules\PreviewModule::getConfigOptionForModule ( string  $option )

protected

Definition at line 152 of file PreviewModule.php.

Referenced by TYPO3\CMS\Adminpanel\Modules\PreviewModule\enrich(), and TYPO3\CMS\Adminpanel\Modules\PreviewModule\onSubmit().

getCssFiles()

TYPO3\CMS\Adminpanel\Modules\PreviewModule::getCssFiles

(

)

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

Implements TYPO3\CMS\Adminpanel\ModuleApi\ResourceProviderInterface.

Definition at line 249 of file PreviewModule.php.

getIconIdentifier()

TYPO3\CMS\Adminpanel\Modules\PreviewModule::getIconIdentifier

(

)

Definition at line 67 of file PreviewModule.php.

getIdentifier()

TYPO3\CMS\Adminpanel\Modules\PreviewModule::getIdentifier

(

)

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

Implements TYPO3\CMS\Adminpanel\ModuleApi\ModuleInterface.

Definition at line 72 of file PreviewModule.php.

getJavaScriptFiles()

TYPO3\CMS\Adminpanel\Modules\PreviewModule::getJavaScriptFiles

(

)

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

Example: return ['EXT:adminpanel/Resources/Public/JavaScript/Modules/Edit.js'];

Implements TYPO3\CMS\Adminpanel\ModuleApi\ResourceProviderInterface.

Definition at line 227 of file PreviewModule.php.

getLabel()

TYPO3\CMS\Adminpanel\Modules\PreviewModule::getLabel

(

)

Module label

Implements TYPO3\CMS\Adminpanel\ModuleApi\ModuleInterface.

Definition at line 77 of file PreviewModule.php.

References TYPO3\CMS\Adminpanel\ModuleApi\AbstractModule\getLanguageService().

getPageSettings()

TYPO3\CMS\Adminpanel\Modules\PreviewModule::getPageSettings

(

)

Implements TYPO3\CMS\Adminpanel\ModuleApi\PageSettingsProviderInterface.

Definition at line 117 of file PreviewModule.php.

References $GLOBALS.

initializeFrontendPreview()

TYPO3\CMS\Adminpanel\Modules\PreviewModule::initializeFrontendPreview ( bool  $showHiddenPages, bool  $showHiddenRecords, bool  $showScheduledRecords, int  $simulateDate, int  $simulateUserGroup, ServerRequestInterface  $request  )

protected

Initialize frontend preview functionality incl. simulation of users or time

Exceptions

Definition at line 166 of file PreviewModule.php.

References $GLOBALS, and TYPO3\CMS\Adminpanel\Modules\PreviewModule\clearPreviewSettings().

Referenced by TYPO3\CMS\Adminpanel\Modules\PreviewModule\enrich().

onSubmit()

TYPO3\CMS\Adminpanel\Modules\PreviewModule::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)

Implements TYPO3\CMS\Adminpanel\ModuleApi\OnSubmitActorInterface.

Definition at line 254 of file PreviewModule.php.

References TYPO3\CMS\Adminpanel\Modules\PreviewModule\getConfigOptionForModule().

Member Data Documentation

$config

array TYPO3\CMS\Adminpanel\Modules\PreviewModule::$config

protected

Definition at line 61 of file PreviewModule.php.