TYPO3\CMS\Workspaces\Controller\PreviewController Class Reference

Public Member Functions
	__construct (StagesService $stageService, WorkspaceService $workspaceService, PageRenderer $pageRenderer, UriBuilder $uriBuilder, SiteFinder $siteFinder, ModuleTemplateFactory $moduleTemplateFactory)
ResponseInterface	handleRequest (ServerRequestInterface $request)

Protected Member Functions
	initializeView (string $templateName)
bool	isValidStage ($stageArray)
BackendUserAuthentication	getBackendUser ()
	generateUrl (Site $site, int $pageUid, array $parameters)

Protected Attributes
int	$pageId
ModuleTemplate	$moduleTemplate
ViewInterface	$view
StagesService	$stageService
WorkspaceService	$workspaceService
PageRenderer	$pageRenderer
UriBuilder	$uriBuilder
SiteFinder	$siteFinder
ModuleTemplateFactory	$moduleTemplateFactory

Detailed Description

Implements the preview controller of the workspace module.

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

Definition at line 45 of file PreviewController.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Workspaces\Controller\PreviewController::__construct	(	StagesService	$stageService,
		WorkspaceService	$workspaceService,
		PageRenderer	$pageRenderer,
		UriBuilder	$uriBuilder,
		SiteFinder	$siteFinder,
		ModuleTemplateFactory	$moduleTemplateFactory
	)

Definition at line 68 of file PreviewController.php.

References TYPO3\CMS\Workspaces\Controller\PreviewController\$moduleTemplateFactory, TYPO3\CMS\Workspaces\Controller\PreviewController\$pageRenderer, TYPO3\CMS\Workspaces\Controller\PreviewController\$siteFinder, TYPO3\CMS\Workspaces\Controller\PreviewController\$stageService, TYPO3\CMS\Workspaces\Controller\PreviewController\$uriBuilder, and TYPO3\CMS\Workspaces\Controller\PreviewController\$workspaceService.

Member Function Documentation

generateUrl()

TYPO3\CMS\Workspaces\Controller\PreviewController::generateUrl ( Site  $site, int  $pageUid, array  $parameters  )

protected

Definition at line 233 of file PreviewController.php.

References TYPO3\CMS\Core\Routing\RouterInterface\generateUri(), and TYPO3\CMS\Core\Site\Entity\Site\getRouter().

Referenced by TYPO3\CMS\Workspaces\Controller\PreviewController\handleRequest().

getBackendUser()

BackendUserAuthentication TYPO3\CMS\Workspaces\Controller\PreviewController::getBackendUser ( )

protected

Returns

‪BackendUserAuthentication

Definition at line 228 of file PreviewController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Workspaces\Controller\PreviewController\handleRequest().

handleRequest()

ResponseInterface TYPO3\CMS\Workspaces\Controller\PreviewController::handleRequest

(

ServerRequestInterface

$request

)

Basically makes sure that the workspace preview is rendered. The preview itself consists of three frames, so there are only the frames-urls we have to generate here

Parameters

ServerRequestInterface

$request

Returns

‪ResponseInterface

Definition at line 106 of file PreviewController.php.

References $GLOBALS, TYPO3\CMS\Workspaces\Controller\PreviewController\generateUrl(), TYPO3\CMS\Workspaces\Controller\PreviewController\getBackendUser(), TYPO3\CMS\Workspaces\Controller\PreviewController\initializeView(), TYPO3\CMS\Workspaces\Service\WorkspaceService\isNewPage(), TYPO3\CMS\Workspaces\Controller\PreviewController\isValidStage(), TYPO3\CMS\Core\Authentication\BackendUserAuthentication\setWorkspace(), TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode(), and TYPO3\CMS\Core\Information\Typo3Information\URL_COMMUNITY.

initializeView()

TYPO3\CMS\Workspaces\Controller\PreviewController::initializeView ( string  $templateName )

protected

Sets up the view

Parameters

string

$templateName

Definition at line 89 of file PreviewController.php.

Referenced by TYPO3\CMS\Workspaces\Controller\PreviewController\handleRequest().

isValidStage()

bool TYPO3\CMS\Workspaces\Controller\PreviewController::isValidStage (   $stageArray )

protected

Evaluate the activate state based on given $stageArray.

Parameters

array

$stageArray

Returns

‪bool

Definition at line 220 of file PreviewController.php.

Referenced by TYPO3\CMS\Workspaces\Controller\PreviewController\handleRequest().

Member Data Documentation

$moduleTemplate

ModuleTemplate TYPO3\CMS\Workspaces\Controller\PreviewController::$moduleTemplate

protected

ModuleTemplate object

Definition at line 55 of file PreviewController.php.

$moduleTemplateFactory

ModuleTemplateFactory TYPO3\CMS\Workspaces\Controller\PreviewController::$moduleTemplateFactory

protected

Definition at line 66 of file PreviewController.php.

Referenced by TYPO3\CMS\Workspaces\Controller\PreviewController\__construct().

$pageId

int TYPO3\CMS\Workspaces\Controller\PreviewController::$pageId

protected

Definition at line 49 of file PreviewController.php.

$pageRenderer

PageRenderer TYPO3\CMS\Workspaces\Controller\PreviewController::$pageRenderer

protected

Definition at line 63 of file PreviewController.php.

Referenced by TYPO3\CMS\Workspaces\Controller\PreviewController\__construct().

$siteFinder

SiteFinder TYPO3\CMS\Workspaces\Controller\PreviewController::$siteFinder

protected

Definition at line 65 of file PreviewController.php.

Referenced by TYPO3\CMS\Workspaces\Controller\PreviewController\__construct().

$stageService

StagesService TYPO3\CMS\Workspaces\Controller\PreviewController::$stageService

protected

Definition at line 61 of file PreviewController.php.

Referenced by TYPO3\CMS\Workspaces\Controller\PreviewController\__construct().

$uriBuilder

UriBuilder TYPO3\CMS\Workspaces\Controller\PreviewController::$uriBuilder

protected

Definition at line 64 of file PreviewController.php.

Referenced by TYPO3\CMS\Workspaces\Controller\PreviewController\__construct().

$view

ViewInterface TYPO3\CMS\Workspaces\Controller\PreviewController::$view

protected

Definition at line 59 of file PreviewController.php.

$workspaceService

WorkspaceService TYPO3\CMS\Workspaces\Controller\PreviewController::$workspaceService

protected

Definition at line 62 of file PreviewController.php.

Referenced by TYPO3\CMS\Workspaces\Controller\PreviewController\__construct().