TYPO3\CMS\Workspaces\Controller\ReviewController Class Reference

Public Member Functions
	__construct (WorkspaceService $workspaceService, StagesService $stagesService, IconFactory $iconFactory, PageRenderer $pageRenderer, UriBuilder $uriBuilder, ModuleTemplateFactory $moduleTemplateFactory)
ResponseInterface	indexAction (ServerRequestInterface $request)

Protected Member Functions
	initializeAction ()
	makeActionMenu (array $availableWorkspaces)
array	prepareWorkspaceTabs (array $workspaceList, int $activeWorkspace)
string	getModuleUri (int $workspaceId=null)
bool	canCreatePreviewLink (int $pageUid, int $workspaceUid)
string	getLanguageSelection ()
	getDepthSelection ()
	getStageSelection ()
bool	customWorkspaceExists (array $workspaceList)
LanguageService	getLanguageService ()
BackendUserAuthentication	getBackendUser ()
array	getSystemLanguages (int $pageId)
	getStageActions ()
	getAvailableSelectStages ()

Protected Attributes
ModuleTemplate	$moduleTemplate
StandaloneView	$view
int	$pageId
WorkspaceService	$workspaceService
StagesService	$stagesService
IconFactory	$iconFactory
PageRenderer	$pageRenderer
UriBuilder	$uriBuilder
ModuleTemplateFactory	$moduleTemplateFactory

Detailed Description

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

Definition at line 41 of file ReviewController.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Workspaces\Controller\ReviewController::__construct	(	WorkspaceService	$workspaceService,
		StagesService	$stagesService,
		IconFactory	$iconFactory,
		PageRenderer	$pageRenderer,
		UriBuilder	$uriBuilder,
		ModuleTemplateFactory	$moduleTemplateFactory
	)

Definition at line 62 of file ReviewController.php.

References TYPO3\CMS\Workspaces\Controller\ReviewController\$iconFactory, TYPO3\CMS\Workspaces\Controller\ReviewController\$moduleTemplateFactory, TYPO3\CMS\Workspaces\Controller\ReviewController\$pageRenderer, TYPO3\CMS\Workspaces\Controller\ReviewController\$stagesService, TYPO3\CMS\Workspaces\Controller\ReviewController\$uriBuilder, and TYPO3\CMS\Workspaces\Controller\ReviewController\$workspaceService.

Member Function Documentation

canCreatePreviewLink()

bool TYPO3\CMS\Workspaces\Controller\ReviewController::canCreatePreviewLink ( int  $pageUid, int  $workspaceUid  )

protected

Determine whether this page for the current

Parameters

int	$pageUid
int	$workspaceUid

Returns

‪bool

Definition at line 298 of file ReviewController.php.

References TYPO3\CMS\Core\Type\Enumeration\cast(), and TYPO3\CMS\Core\Versioning\VersionState\DELETE_PLACEHOLDER.

Referenced by TYPO3\CMS\Workspaces\Controller\ReviewController\indexAction().

customWorkspaceExists()

bool TYPO3\CMS\Workspaces\Controller\ReviewController::customWorkspaceExists ( array  $workspaceList )

protected

Returns true if at least one custom workspace next to live workspace exists.

Parameters

array

$workspaceList

Returns

‪bool

Definition at line 340 of file ReviewController.php.

Referenced by TYPO3\CMS\Workspaces\Controller\ReviewController\indexAction().

getAvailableSelectStages()

TYPO3\CMS\Workspaces\Controller\ReviewController::getAvailableSelectStages ( )

protected

Get stages to be used in the review filter. This basically adds -99 (all stages) and removes -20 (publish).

Definition at line 413 of file ReviewController.php.

References TYPO3\CMS\Workspaces\Controller\ReviewController\getLanguageService().

getBackendUser()

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

protected

Returns

‪BackendUserAuthentication

Definition at line 361 of file ReviewController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Workspaces\Controller\ReviewController\getDepthSelection(), TYPO3\CMS\Workspaces\Controller\ReviewController\getLanguageSelection(), TYPO3\CMS\Workspaces\Controller\ReviewController\getStageActions(), TYPO3\CMS\Workspaces\Controller\ReviewController\getStageSelection(), TYPO3\CMS\Workspaces\Controller\ReviewController\indexAction(), and TYPO3\CMS\Workspaces\Controller\ReviewController\initializeAction().

getDepthSelection()

TYPO3\CMS\Workspaces\Controller\ReviewController::getDepthSelection ( )

protected

Definition at line 322 of file ReviewController.php.

References TYPO3\CMS\Workspaces\Controller\ReviewController\getBackendUser(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getModuleData().

getLanguageSelection()

string TYPO3\CMS\Workspaces\Controller\ReviewController::getLanguageSelection ( )

protected

Gets the selected language.

Returns

‪string

Definition at line 316 of file ReviewController.php.

References TYPO3\CMS\Workspaces\Controller\ReviewController\getBackendUser(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getModuleData().

Referenced by TYPO3\CMS\Workspaces\Controller\ReviewController\getSystemLanguages().

getLanguageService()

LanguageService TYPO3\CMS\Workspaces\Controller\ReviewController::getLanguageService ( )

protected

Returns

‪LanguageService

Definition at line 353 of file ReviewController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Workspaces\Controller\ReviewController\getAvailableSelectStages(), TYPO3\CMS\Workspaces\Controller\ReviewController\getStageActions(), and TYPO3\CMS\Workspaces\Controller\ReviewController\indexAction().

getModuleUri()

string TYPO3\CMS\Workspaces\Controller\ReviewController::getModuleUri ( int  $workspaceId = null )

protected

Gets the module URI.

Parameters

int

$workspaceId

Returns

‪string

Definition at line 280 of file ReviewController.php.

References TYPO3\CMS\Workspaces\Controller\ReviewController\$pageId.

Referenced by TYPO3\CMS\Workspaces\Controller\ReviewController\prepareWorkspaceTabs().

getStageActions()

TYPO3\CMS\Workspaces\Controller\ReviewController::getStageActions ( )

protected

Get list of available mass workspace actions.

Definition at line 391 of file ReviewController.php.

References TYPO3\CMS\Workspaces\Controller\ReviewController\getBackendUser(), TYPO3\CMS\Workspaces\Controller\ReviewController\getLanguageService(), TYPO3\CMS\Workspaces\Service\WorkspaceService\LIVE_WORKSPACE_ID, and TYPO3\CMS\Core\Localization\LanguageService\sL().

getStageSelection()

TYPO3\CMS\Workspaces\Controller\ReviewController::getStageSelection ( )

protected

Definition at line 328 of file ReviewController.php.

References TYPO3\CMS\Workspaces\Controller\ReviewController\getBackendUser(), and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\getModuleData().

getSystemLanguages()

array TYPO3\CMS\Workspaces\Controller\ReviewController::getSystemLanguages ( int  $pageId )

protected

Gets all available system languages.

Parameters

int

$pageId

Returns

‪array

Definition at line 372 of file ReviewController.php.

References TYPO3\CMS\Workspaces\Controller\ReviewController\$pageId, and TYPO3\CMS\Workspaces\Controller\ReviewController\getLanguageSelection().

indexAction()

ResponseInterface TYPO3\CMS\Workspaces\Controller\ReviewController::indexAction

(

ServerRequestInterface

$request

)

Renders the review module user dependent with all workspaces. The module will show all records of one workspace.

Parameters

ServerRequestInterface

$request

Returns

‪ResponseInterface

Definition at line 110 of file ReviewController.php.

References TYPO3\CMS\Workspaces\Controller\ReviewController\$pageId, TYPO3\CMS\Backend\Template\Components\ButtonBar\BUTTON_POSITION_LEFT, TYPO3\CMS\Workspaces\Controller\ReviewController\canCreatePreviewLink(), TYPO3\CMS\Workspaces\Controller\ReviewController\customWorkspaceExists(), TYPO3\CMS\Workspaces\Controller\ReviewController\getBackendUser(), TYPO3\CMS\Workspaces\Controller\ReviewController\getLanguageService(), TYPO3\CMS\Workspaces\Service\WorkspaceService\getWorkspaceTitle(), TYPO3\CMS\Workspaces\Controller\ReviewController\initializeAction(), TYPO3\CMS\Workspaces\Service\WorkspaceService\LIVE_WORKSPACE_ID, TYPO3\CMS\Workspaces\Controller\ReviewController\makeActionMenu(), TYPO3\CMS\Workspaces\Controller\ReviewController\prepareWorkspaceTabs(), TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL, and TYPO3\CMS\Core\Localization\LanguageService\sL().

initializeAction()

TYPO3\CMS\Workspaces\Controller\ReviewController::initializeAction ( )

protected

Initializes the controller before invoking an action method.

Definition at line 81 of file ReviewController.php.

References TYPO3\CMS\Workspaces\Controller\ReviewController\getBackendUser(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

Referenced by TYPO3\CMS\Workspaces\Controller\ReviewController\indexAction().

makeActionMenu()

TYPO3\CMS\Workspaces\Controller\ReviewController::makeActionMenu ( array  $availableWorkspaces )

protected

This creates the dropdown menu with the different actions this module is able to provide.

Parameters

array

$availableWorkspaces

‪array with the available actions

Definition at line 224 of file ReviewController.php.

Referenced by TYPO3\CMS\Workspaces\Controller\ReviewController\indexAction().

prepareWorkspaceTabs()

array TYPO3\CMS\Workspaces\Controller\ReviewController::prepareWorkspaceTabs ( array  $workspaceList, int  $activeWorkspace  )

protected

Prepares available workspace tabs.

Parameters

array	$workspaceList
int	$activeWorkspace

Returns

‪array

Definition at line 249 of file ReviewController.php.

References TYPO3\CMS\Workspaces\Controller\ReviewController\getModuleUri().

Referenced by TYPO3\CMS\Workspaces\Controller\ReviewController\indexAction().

Member Data Documentation

$iconFactory

IconFactory TYPO3\CMS\Workspaces\Controller\ReviewController::$iconFactory

protected

Definition at line 57 of file ReviewController.php.

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

$moduleTemplate

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

protected

Definition at line 45 of file ReviewController.php.

$moduleTemplateFactory

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

protected

Definition at line 60 of file ReviewController.php.

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

$pageId

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

protected

Definition at line 53 of file ReviewController.php.

Referenced by TYPO3\CMS\Workspaces\Controller\ReviewController\getModuleUri(), TYPO3\CMS\Workspaces\Controller\ReviewController\getSystemLanguages(), and TYPO3\CMS\Workspaces\Controller\ReviewController\indexAction().

$pageRenderer

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

protected

Definition at line 58 of file ReviewController.php.

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

$stagesService

StagesService TYPO3\CMS\Workspaces\Controller\ReviewController::$stagesService

protected

Definition at line 56 of file ReviewController.php.

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

$uriBuilder

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

protected

Definition at line 59 of file ReviewController.php.

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

$view

StandaloneView TYPO3\CMS\Workspaces\Controller\ReviewController::$view

protected

Definition at line 49 of file ReviewController.php.

$workspaceService

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

protected

Definition at line 55 of file ReviewController.php.

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