TYPO3\CMS\Adminpanel\Modules\PreviewModule Class Reference

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

Public Member Functions
	getIconIdentifier ()
	getIdentifier ()
	getLabel ()
	initializeModule (ServerRequestInterface $request)
	getPageSettings ()
array	getJavaScriptFiles ()
array	getCssFiles ()
‪Public Member Functions inherited from ‪TYPO3\CMS\Adminpanel\ModuleApi\AbstractModule
	__construct ()
bool	isEnabled ()
	setSubModules (array $subModules)
	getSubModules ()
	hasSubmoduleSettings ()

Protected Member Functions
string	getConfigOptionForModule (string $option)
TypoScriptFrontendController	getTypoScriptFrontendController ()
	initializeFrontendPreview (bool $showHiddenPages, bool $showHiddenRecords, int $simulateDate, int $simulateUserGroup)
int	parseDate (int $simulateDate)
‪Protected Member Functions inherited from ‪TYPO3\CMS\Adminpanel\ModuleApi\AbstractModule
BackendUserAuthentication FrontendBackendUserAuthentication	getBackendUser ()
LanguageService	getLanguageService ()
bool	isEnabledViaTsConfig ()

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

Detailed Description

Admin Panel Preview Module

Definition at line 37 of file PreviewModule.php.

Member Function Documentation

getConfigOptionForModule()

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

protected

Parameters

string

$option

Returns

‪string

Definition at line 133 of file PreviewModule.php.

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

getCssFiles()

array TYPO3\CMS\Adminpanel\Modules\PreviewModule::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 252 of file PreviewModule.php.

getIconIdentifier()

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

(

)

Definition at line 48 of file PreviewModule.php.

getIdentifier()

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

(

)

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

Returns

‪string

Implements TYPO3\CMS\Adminpanel\ModuleApi\ModuleInterface.

Definition at line 56 of file PreviewModule.php.

getJavaScriptFiles()

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

(

)

Returns

‪array

Implements TYPO3\CMS\Adminpanel\ModuleApi\ResourceProviderInterface.

Definition at line 222 of file PreviewModule.php.

getLabel()

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

(

)

‪Module label

Returns

‪string

Implements TYPO3\CMS\Adminpanel\ModuleApi\ModuleInterface.

Definition at line 64 of file PreviewModule.php.

References TYPO3\CMS\Adminpanel\ModuleApi\AbstractModule\getLanguageService(), and TYPO3\CMS\Core\Localization\LanguageService\sL().

getPageSettings()

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

(

)

Returns

‪string

Implements TYPO3\CMS\Adminpanel\ModuleApi\PageSettingsProviderInterface.

Definition at line 102 of file PreviewModule.php.

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

getTypoScriptFrontendController()

TypoScriptFrontendController TYPO3\CMS\Adminpanel\Modules\PreviewModule::getTypoScriptFrontendController ( )

protected

Returns

‪TypoScriptFrontendController

Definition at line 144 of file PreviewModule.php.

References $GLOBALS.

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

initializeFrontendPreview()

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

protected

Initialize frontend preview functionality incl. simulation of users or time

Parameters

bool	$showHiddenPages
bool	$showHiddenRecords
int	$simulateDate
int	$simulateUserGroup	‪UID of the fe_group to simulate

Exceptions

Definition at line 159 of file PreviewModule.php.

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

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

initializeModule()

TYPO3\CMS\Adminpanel\Modules\PreviewModule::initializeModule

(

ServerRequestInterface

$request

)

‪Initialize the module - runs early in a TYPO3 request

Parameters

ServerRequestInterface

$request

Implements TYPO3\CMS\Adminpanel\ModuleApi\InitializableInterface.

Definition at line 74 of file PreviewModule.php.

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

parseDate()

int TYPO3\CMS\Adminpanel\Modules\PreviewModule::parseDate ( int  $simulateDate )

protected

The simulated date needs to be a timestring (UTC)

Simulation date is either set via configuration of AdminPanel (Date and Time Fields) or via ADMCMD_ $_GET parameter from backend previews

Parameters

int

$simulateDate

Returns

‪int

Definition at line 236 of file PreviewModule.php.

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

Member Data Documentation

$config

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

protected

module configuration, set on initialize

Definition at line 43 of file PreviewModule.php.