TYPO3\CMS\Viewpage\Controller\ViewModuleController Class Reference

Public Member Functions
	__construct ()
ResponseInterface	showAction (ServerRequestInterface $request)

Protected Member Functions
	initializeView (string $templateName)
	registerDocHeader (int $pageId, int $languageId, string $targetUrl)
string	getTypeParameterIfSet (int $pageId)
string null	getDomainName (int $pageId)
array	getPreviewPresets (int $pageId)
array	getPreviewLanguages (int $pageId)
int	getCurrentLanguage (int $pageId, string $languageParam=null)
bool	isValidDoktype (int $pageId=0)
BackendUserAuthentication	getBackendUser ()
LanguageService	getLanguageService ()

Protected Attributes
ModuleTemplate	$moduleTemplate
ViewInterface	$view

Detailed Description

Controller for viewing the frontend

This is a specific Backend Controller implementation and is not considered part of the Public TYPO3 API.

Definition at line 43 of file ViewModuleController.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Viewpage\Controller\ViewModuleController::__construct

(

)

Initialize module template and language service

Definition at line 60 of file ViewModuleController.php.

References TYPO3\CMS\Viewpage\Controller\ViewModuleController\getLanguageService(), and TYPO3\CMS\Core\Localization\LanguageService\includeLLFile().

Member Function Documentation

getBackendUser()

BackendUserAuthentication TYPO3\CMS\Viewpage\Controller\ViewModuleController::getBackendUser ( )

protected

Returns

‪BackendUserAuthentication

Definition at line 385 of file ViewModuleController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Viewpage\Controller\ViewModuleController\getCurrentLanguage(), TYPO3\CMS\Viewpage\Controller\ViewModuleController\getPreviewLanguages(), TYPO3\CMS\Viewpage\Controller\ViewModuleController\registerDocHeader(), and TYPO3\CMS\Viewpage\Controller\ViewModuleController\showAction().

getCurrentLanguage()

int TYPO3\CMS\Viewpage\Controller\ViewModuleController::getCurrentLanguage ( int  $pageId, string  $languageParam = null  )

protected

Returns the current language

Parameters

int	$pageId
string	$languageParam

Returns

‪int

Definition at line 345 of file ViewModuleController.php.

References TYPO3\CMS\Viewpage\Controller\ViewModuleController\getBackendUser(), TYPO3\CMS\Viewpage\Controller\ViewModuleController\getPreviewLanguages(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\writeUC().

Referenced by TYPO3\CMS\Viewpage\Controller\ViewModuleController\showAction().

getDomainName()

string null TYPO3\CMS\Viewpage\Controller\ViewModuleController::getDomainName ( int  $pageId )

protected

Get domain name for requested page id

Parameters

int

$pageId

Returns

‪string|null Domain name from first sys_domains-Record or from TCEMAIN.previewDomain, NULL if neither is configured

Definition at line 235 of file ViewModuleController.php.

References TYPO3\CMS\Backend\Utility\BackendUtility\BEgetRootLine(), TYPO3\CMS\Backend\Utility\BackendUtility\firstDomainRecord(), and TYPO3\CMS\Backend\Utility\BackendUtility\getPagesTSconfig().

getLanguageService()

LanguageService TYPO3\CMS\Viewpage\Controller\ViewModuleController::getLanguageService ( )

protected

Returns

‪LanguageService

Definition at line 393 of file ViewModuleController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Viewpage\Controller\ViewModuleController\__construct(), TYPO3\CMS\Viewpage\Controller\ViewModuleController\getPreviewLanguages(), TYPO3\CMS\Viewpage\Controller\ViewModuleController\getPreviewPresets(), TYPO3\CMS\Viewpage\Controller\ViewModuleController\registerDocHeader(), and TYPO3\CMS\Viewpage\Controller\ViewModuleController\showAction().

getPreviewLanguages()

array TYPO3\CMS\Viewpage\Controller\ViewModuleController::getPreviewLanguages ( int  $pageId )

protected

Returns the preview languages

Parameters

int

$pageId

Returns

‪array

Definition at line 290 of file ViewModuleController.php.

References $GLOBALS, TYPO3\CMS\Viewpage\Controller\ViewModuleController\getBackendUser(), TYPO3\CMS\Viewpage\Controller\ViewModuleController\getLanguageService(), TYPO3\CMS\Backend\Utility\BackendUtility\getPagesTSconfig(), and TYPO3\CMS\Core\Localization\LanguageService\sL().

Referenced by TYPO3\CMS\Viewpage\Controller\ViewModuleController\getCurrentLanguage(), and TYPO3\CMS\Viewpage\Controller\ViewModuleController\registerDocHeader().

getPreviewPresets()

array TYPO3\CMS\Viewpage\Controller\ViewModuleController::getPreviewPresets ( int  $pageId )

protected

Get available presets for page id

Parameters

int

$pageId

Returns

‪array

Definition at line 247 of file ViewModuleController.php.

References TYPO3\CMS\Viewpage\Controller\ViewModuleController\getLanguageService(), TYPO3\CMS\Backend\Utility\BackendUtility\getPagesTSconfig(), and TYPO3\CMS\Core\Localization\LanguageService\sL().

Referenced by TYPO3\CMS\Viewpage\Controller\ViewModuleController\showAction().

getTypeParameterIfSet()

string TYPO3\CMS\Viewpage\Controller\ViewModuleController::getTypeParameterIfSet ( int  $pageId )

protected

With page TS config it is possible to force a specific type id via mod.web_view.type for a page id or a page tree. The method checks if a type is set for the given id and returns the additional GET string.

Parameters

int

$pageId

Returns

‪string

Definition at line 219 of file ViewModuleController.php.

References TYPO3\CMS\Backend\Utility\BackendUtility\getPagesTSconfig().

Referenced by TYPO3\CMS\Viewpage\Controller\ViewModuleController\showAction().

initializeView()

TYPO3\CMS\Viewpage\Controller\ViewModuleController::initializeView ( string  $templateName )

protected

Initialize view

Parameters

string

$templateName

Definition at line 73 of file ViewModuleController.php.

Referenced by TYPO3\CMS\Viewpage\Controller\ViewModuleController\showAction().

isValidDoktype()

bool TYPO3\CMS\Viewpage\Controller\ViewModuleController::isValidDoktype ( int  $pageId = 0 )

protected

Verifies if doktype of given page is valid

Parameters

int

$pageId

Returns

‪bool

Definition at line 367 of file ViewModuleController.php.

References TYPO3\CMS\Frontend\Page\PageRepository\DOKTYPE_RECYCLER, TYPO3\CMS\Frontend\Page\PageRepository\DOKTYPE_SPACER, TYPO3\CMS\Frontend\Page\PageRepository\DOKTYPE_SYSFOLDER, and TYPO3\CMS\Backend\Utility\BackendUtility\getRecord().

Referenced by TYPO3\CMS\Viewpage\Controller\ViewModuleController\showAction().

registerDocHeader()

TYPO3\CMS\Viewpage\Controller\ViewModuleController::registerDocHeader ( int  $pageId, int  $languageId, string  $targetUrl  )

protected

Registers the docheader

Parameters

int	$pageId
int	$languageId
string	$targetUrl

Definition at line 90 of file ViewModuleController.php.

References TYPO3\CMS\Backend\Template\Components\ButtonBar\BUTTON_POSITION_RIGHT, TYPO3\CMS\Viewpage\Controller\ViewModuleController\getBackendUser(), TYPO3\CMS\Viewpage\Controller\ViewModuleController\getLanguageService(), TYPO3\CMS\Viewpage\Controller\ViewModuleController\getPreviewLanguages(), TYPO3\CMS\Core\Authentication\BackendUserAuthentication\mayMakeShortcut(), TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL, and TYPO3\CMS\Core\Localization\LanguageService\sL().

Referenced by TYPO3\CMS\Viewpage\Controller\ViewModuleController\showAction().

showAction()

ResponseInterface TYPO3\CMS\Viewpage\Controller\ViewModuleController::showAction

(

ServerRequestInterface

$request

)

Show selected page from pagetree in iframe

Parameters

ServerRequestInterface

$request

Returns

‪ResponseInterface

Exceptions

Definition at line 150 of file ViewModuleController.php.

References $icons, TYPO3\CMS\Viewpage\Controller\ViewModuleController\getBackendUser(), TYPO3\CMS\Viewpage\Controller\ViewModuleController\getCurrentLanguage(), TYPO3\CMS\Viewpage\Controller\ViewModuleController\getLanguageService(), TYPO3\CMS\Viewpage\Controller\ViewModuleController\getPreviewPresets(), TYPO3\CMS\Backend\Utility\BackendUtility\getPreviewUrl(), TYPO3\CMS\Viewpage\Controller\ViewModuleController\getTypeParameterIfSet(), TYPO3\CMS\Core\Messaging\AbstractMessage\INFO, TYPO3\CMS\Viewpage\Controller\ViewModuleController\initializeView(), TYPO3\CMS\Viewpage\Controller\ViewModuleController\isValidDoktype(), TYPO3\CMS\Viewpage\Controller\ViewModuleController\registerDocHeader(), TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL, and TYPO3\CMS\Core\Localization\LanguageService\sL().

Member Data Documentation

$moduleTemplate

ModuleTemplate TYPO3\CMS\Viewpage\Controller\ViewModuleController::$moduleTemplate

protected

ModuleTemplate object

Definition at line 49 of file ViewModuleController.php.

$view

ViewInterface TYPO3\CMS\Viewpage\Controller\ViewModuleController::$view

protected

View

Definition at line 55 of file ViewModuleController.php.