‪TYPO3CMS  9.5
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Workspaces\Controller\ReviewController Class Reference
Inheritance diagram for TYPO3\CMS\Workspaces\Controller\ReviewController:
TYPO3\CMS\Extbase\Mvc\Controller\ActionController TYPO3\CMS\Extbase\Mvc\Controller\AbstractController TYPO3\CMS\Extbase\Mvc\Controller\ControllerInterface

Public Member Functions

 indexAction ()
 
 fullIndexAction ()
 
 singleIndexAction ()
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\ActionController
 injectReflectionService (\TYPO3\CMS\Extbase\Reflection\ReflectionService $reflectionService)
 
 injectCacheService (\TYPO3\CMS\Extbase\Service\CacheService $cacheService)
 
 injectMvcPropertyMappingConfigurationService (\TYPO3\CMS\Extbase\Mvc\Controller\MvcPropertyMappingConfigurationService $mvcPropertyMappingConfigurationService)
 
 processRequest (\TYPO3\CMS\Extbase\Mvc\RequestInterface $request, \TYPO3\CMS\Extbase\Mvc\ResponseInterface $response)
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\AbstractController
 injectSignalSlotDispatcher (\TYPO3\CMS\Extbase\SignalSlot\Dispatcher $signalSlotDispatcher)
 
 injectValidatorResolver (\TYPO3\CMS\Extbase\Validation\ValidatorResolver $validatorResolver)
 
ControllerContext getControllerContext ()
 
 __construct ()
 
 injectConfigurationManager (ConfigurationManagerInterface $configurationManager)
 
 injectObjectManager (\TYPO3\CMS\Extbase\Object\ObjectManagerInterface $objectManager)
 
 addFlashMessage ($messageBody, $messageTitle='', $severity=\TYPO3\CMS\Core\Messaging\AbstractMessage::OK, $storeInSession=true)
 
bool canProcessRequest (\TYPO3\CMS\Extbase\Mvc\RequestInterface $request)
 
 forward ($actionName, $controllerName=null, $extensionName=null, array $arguments=null)
 
 throwStatus ($statusCode, $statusMessage=null, $content=null)
 
 initializeControllerArgumentsBaseValidators ()
 

Protected Member Functions

 initializeView (ViewInterface $view)
 
 registerButtons ()
 
 initializeAction ()
 
array prepareWorkspaceTabs (array $workspaceList, int $activeWorkspace, bool $showAllWorkspaceTab=true)
 
string getModuleUri (int $workspaceId)
 
 assignExtensionSettings ()
 
bool canCreatePreviewLink (int $pageUid, int $workspaceUid)
 
string getLanguageSelection ()
 
AdditionalColumnService getAdditionalColumnService ()
 
AdditionalResourceService getAdditionalResourceService ()
 
PageRenderer getPageRenderer ()
 
LanguageService getLanguageService ()
 
BackendUserAuthentication getBackendUser ()
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\ActionController
 renderAssetsForRequest ($request)
 
 initializeActionMethodArguments ()
 
 initializeActionMethodValidators ()
 
string resolveActionMethodName ()
 
 callActionMethod ()
 
 emitBeforeCallActionMethodSignal (array $preparedArguments)
 
ViewInterface resolveView ()
 
 setViewConfiguration (ViewInterface $view)
 
array getViewProperty ($extbaseFrameworkConfiguration, $setting)
 
mixed resolveViewObjectName ()
 
string errorAction ()
 
 clearCacheOnError ()
 
 addErrorFlashMessage ()
 
string getErrorFlashMessage ()
 
 forwardToReferringRequest ()
 
string getFlattenedValidationErrorMessage ()
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\AbstractController
TYPO3 CMS Extbase Mvc Controller ControllerContext buildControllerContext ()
 
 redirect ($actionName, $controllerName=null, $extensionName=null, array $arguments=null, $pageUid=null, $delay=0, $statusCode=303)
 
 redirectToUri ($uri, $delay=0, $statusCode=303)
 
string addBaseUriIfNecessary ($uri)
 
 mapRequestArgumentsToControllerArguments ()
 

Protected Attributes

string $defaultViewObjectName = BackendTemplateView::class
 
BackendTemplateView $view
 
PageRenderer $pageRenderer
 
int $pageId
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\ActionController
TYPO3 CMS Extbase Reflection ReflectionService $reflectionService
 
TYPO3 CMS Extbase Service CacheService $cacheService
 
ViewInterface $view
 
string $namespacesViewObjectNamePattern = '@vendor\@extension\View\@controller\@action@format'
 
array $viewFormatToObjectNameMap = array( )
 
string $defaultViewObjectName = \TYPO3\CMS\Fluid\View\TemplateView::class
 
string $actionMethodName = 'indexAction'
 
string $errorMethodName = 'errorAction'
 
TYPO3 CMS Extbase Mvc Controller MvcPropertyMappingConfigurationService $mvcPropertyMappingConfigurationService
 
TYPO3 CMS Extbase Mvc Request $request
 
TYPO3 CMS Extbase Mvc Response $response
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\AbstractController
TYPO3 CMS Extbase SignalSlot Dispatcher $signalSlotDispatcher
 
TYPO3 CMS Extbase Object ObjectManagerInterface $objectManager
 
TYPO3 CMS Extbase Mvc Web Routing UriBuilder $uriBuilder
 
string $extensionName
 
array $settings
 
TYPO3 CMS Extbase Mvc RequestInterface $request
 
TYPO3 CMS Extbase Mvc ResponseInterface $response
 
TYPO3 CMS Extbase Validation ValidatorResolver $validatorResolver
 
TYPO3 CMS Extbase Mvc Controller Arguments $arguments
 
array $supportedRequestTypes = array( \TYPO3\CMS\Extbase\Mvc\Request::class )
 
TYPO3 CMS Extbase Mvc Controller ControllerContext $controllerContext
 
ConfigurationManagerInterface $configurationManager
 

Additional Inherited Members

- ‪Static Public Member Functions inherited from ‪TYPO3\CMS\Extbase\Mvc\Controller\ActionController
static array getActionMethodParameters ($objectManager)
 

Detailed Description

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

Definition at line 36 of file ReviewController.php.

Member Function Documentation

◆ assignExtensionSettings()

TYPO3\CMS\Workspaces\Controller\ReviewController::assignExtensionSettings ( )
protected

Assigns additional Workspace settings to TYPO3.settings.Workspaces.extension

Definition at line 321 of file ReviewController.php.

References TYPO3\CMS\Workspaces\Controller\ReviewController\getAdditionalColumnService(), TYPO3\CMS\Workspaces\Service\AdditionalColumnService\getDefinition(), and TYPO3\CMS\Workspaces\Service\AdditionalColumnService\getHandler().

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

◆ 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 342 of file ReviewController.php.

References TYPO3\CMS\Core\Type\Enumeration\cast(), TYPO3\CMS\Core\Versioning\VersionState\DELETE_PLACEHOLDER, TYPO3\CMS\Backend\Utility\BackendUtility\getRecord(), and TYPO3\CMS\Backend\Utility\BackendUtility\workspaceOL().

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

◆ fullIndexAction()

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

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

Definition at line 206 of file ReviewController.php.

References TYPO3\CMS\Workspaces\Controller\ReviewController\getBackendUser(), TYPO3\CMS\Workspaces\Controller\ReviewController\prepareWorkspaceTabs(), TYPO3\CMS\Workspaces\Service\WorkspaceService\SELECT_ALL_WORKSPACES, and TYPO3\CMS\Core\Authentication\AbstractUserAuthentication\setAndSaveSessionData().

◆ getAdditionalColumnService()

AdditionalColumnService TYPO3\CMS\Workspaces\Controller\ReviewController::getAdditionalColumnService ( )
protected
Returns
‪AdditionalColumnService

Definition at line 373 of file ReviewController.php.

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

◆ getAdditionalResourceService()

AdditionalResourceService TYPO3\CMS\Workspaces\Controller\ReviewController::getAdditionalResourceService ( )
protected
Returns
‪AdditionalResourceService

Definition at line 381 of file ReviewController.php.

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

◆ getBackendUser()

BackendUserAuthentication TYPO3\CMS\Workspaces\Controller\ReviewController::getBackendUser ( )
protected
Returns
‪BackendUserAuthentication

Definition at line 405 of file ReviewController.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Workspaces\Controller\ReviewController\fullIndexAction(), TYPO3\CMS\Workspaces\Controller\ReviewController\getLanguageSelection(), TYPO3\CMS\Workspaces\Controller\ReviewController\indexAction(), TYPO3\CMS\Workspaces\Controller\ReviewController\initializeAction(), and TYPO3\CMS\Workspaces\Controller\ReviewController\singleIndexAction().

◆ getLanguageSelection()

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

Gets the selected language.

Returns
‪string

Definition at line 360 of file ReviewController.php.

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

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

◆ getLanguageService()

LanguageService TYPO3\CMS\Workspaces\Controller\ReviewController::getLanguageService ( )
protected
Returns
‪LanguageService

Definition at line 397 of file ReviewController.php.

References $GLOBALS.

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

◆ getModuleUri()

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

Gets the module URI.

Parameters
int$workspaceId
Returns
‪string

Definition at line 302 of file ReviewController.php.

References TYPO3\CMS\Workspaces\Controller\ReviewController\$pageId, TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\$uriBuilder, and TYPO3\CMS\Workspaces\Service\WorkspaceService\SELECT_ALL_WORKSPACES.

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

◆ getPageRenderer()

PageRenderer TYPO3\CMS\Workspaces\Controller\ReviewController::getPageRenderer ( )
protected
Returns
‪PageRenderer

Definition at line 389 of file ReviewController.php.

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

◆ indexAction()

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

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

Definition at line 140 of file ReviewController.php.

References TYPO3\CMS\Workspaces\Controller\ReviewController\canCreatePreviewLink(), TYPO3\CMS\Workspaces\Controller\ReviewController\getBackendUser(), TYPO3\CMS\Workspaces\Controller\ReviewController\getLanguageService(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecord(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecordTitle(), TYPO3\CMS\Workspaces\Service\WorkspaceService\getWorkspaceTitle(), TYPO3\CMS\Workspaces\Controller\ReviewController\prepareWorkspaceTabs(), TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\redirect(), TYPO3\CMS\Workspaces\Service\WorkspaceService\SELECT_ALL_WORKSPACES, TYPO3\CMS\Backend\Utility\BackendUtility\setUpdateSignal(), 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.

Reimplemented from TYPO3\CMS\Extbase\Mvc\Controller\ActionController.

Definition at line 89 of file ReviewController.php.

References $icons, TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\$uriBuilder, TYPO3\CMS\Workspaces\Controller\ReviewController\assignExtensionSettings(), TYPO3\CMS\Workspaces\Controller\ReviewController\getAdditionalResourceService(), TYPO3\CMS\Workspaces\Controller\ReviewController\getBackendUser(), TYPO3\CMS\Workspaces\Controller\ReviewController\getLanguageSelection(), TYPO3\CMS\Workspaces\Controller\ReviewController\getLanguageService(), TYPO3\CMS\Workspaces\Controller\ReviewController\getPageRenderer(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

◆ initializeView()

TYPO3\CMS\Workspaces\Controller\ReviewController::initializeView ( ViewInterface  $view)
protected

Set up the doc header properly here

Parameters
ViewInterface$view

Reimplemented from TYPO3\CMS\Extbase\Mvc\Controller\ActionController.

Definition at line 59 of file ReviewController.php.

References TYPO3\CMS\Workspaces\Controller\ReviewController\$view, and TYPO3\CMS\Workspaces\Controller\ReviewController\registerButtons().

◆ prepareWorkspaceTabs()

array TYPO3\CMS\Workspaces\Controller\ReviewController::prepareWorkspaceTabs ( array  $workspaceList,
int  $activeWorkspace,
bool  $showAllWorkspaceTab = true 
)
protected

Prepares available workspace tabs.

Parameters
array$workspaceList
int$activeWorkspace
bool$showAllWorkspaceTab
Returns
‪array

Definition at line 259 of file ReviewController.php.

References TYPO3\CMS\Workspaces\Controller\ReviewController\getModuleUri(), and TYPO3\CMS\Workspaces\Service\WorkspaceService\SELECT_ALL_WORKSPACES.

Referenced by TYPO3\CMS\Workspaces\Controller\ReviewController\fullIndexAction(), TYPO3\CMS\Workspaces\Controller\ReviewController\indexAction(), and TYPO3\CMS\Workspaces\Controller\ReviewController\singleIndexAction().

◆ registerButtons()

TYPO3\CMS\Workspaces\Controller\ReviewController::registerButtons ( )
protected

Registers the DocHeader buttons

Definition at line 69 of file ReviewController.php.

References TYPO3\CMS\Extbase\Mvc\Controller\AbstractController\$extensionName, TYPO3\CMS\Extbase\Mvc\Controller\ActionController\$request, and TYPO3\CMS\Extbase\Mvc\Cli\Request\getArguments().

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

◆ singleIndexAction()

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

Renders the review module for a single page. This is used within the workspace-preview frame.

Definition at line 235 of file ReviewController.php.

References TYPO3\CMS\Workspaces\Controller\ReviewController\getBackendUser(), and TYPO3\CMS\Workspaces\Controller\ReviewController\prepareWorkspaceTabs().

Member Data Documentation

◆ $defaultViewObjectName

string TYPO3\CMS\Workspaces\Controller\ReviewController::$defaultViewObjectName = BackendTemplateView::class
protected

Definition at line 40 of file ReviewController.php.

◆ $pageId

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

Definition at line 52 of file ReviewController.php.

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

◆ $pageRenderer

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

Definition at line 48 of file ReviewController.php.

◆ $view

BackendTemplateView TYPO3\CMS\Workspaces\Controller\ReviewController::$view
protected

Definition at line 44 of file ReviewController.php.

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