ViewModuleController
Controller to show a frontend page in the backend. Backend "View" module.
This is a specific Backend Controller implementation and is not considered part of the Public TYPO3 API.
Attributes
- #[AsController]
Table of Contents
Properties
- $iconFactory : IconFactory
- $moduleTemplateFactory : ModuleTemplateFactory
- $pageRepository : PageRepository
- $policyRegistry : PolicyRegistry
- $siteFinder : SiteFinder
- $uriBuilder : UriBuilder
Methods
- __construct() : mixed
- handleRequest() : ResponseInterface
- Show selected page.
- getBackendUser() : BackendUserAuthentication
- getLanguageService() : LanguageService
- getPreviewLanguages() : array<string|int, mixed>
- Returns the preview languages
- getPreviewPresets() : array<string|int, mixed>
- Get available presets for page id.
- getShortcutTitle() : string
- Returns the shortcut title for the current page.
- getTypeParameterIfSet() : string
- 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.
- isValidDoktype() : bool
- Verifies if doktype of given page is valid - not a folder / spacer / .
- registerDocHeader() : mixed
Properties
$iconFactory read-only
protected
IconFactory
$iconFactory
$moduleTemplateFactory read-only
protected
ModuleTemplateFactory
$moduleTemplateFactory
$pageRepository read-only
protected
PageRepository
$pageRepository
$policyRegistry read-only
protected
PolicyRegistry
$policyRegistry
$siteFinder read-only
protected
SiteFinder
$siteFinder
$uriBuilder read-only
protected
UriBuilder
$uriBuilder
Methods
__construct()
public
__construct(ModuleTemplateFactory $moduleTemplateFactory, IconFactory $iconFactory, UriBuilder $uriBuilder, PageRepository $pageRepository, SiteFinder $siteFinder, PolicyRegistry $policyRegistry) : mixed
Parameters
- $moduleTemplateFactory : ModuleTemplateFactory
- $iconFactory : IconFactory
- $uriBuilder : UriBuilder
- $pageRepository : PageRepository
- $siteFinder : SiteFinder
- $policyRegistry : PolicyRegistry
handleRequest()
Show selected page.
public
handleRequest(ServerRequestInterface $request) : ResponseInterface
Parameters
- $request : ServerRequestInterface
Return values
ResponseInterfacegetBackendUser()
protected
getBackendUser() : BackendUserAuthentication
Return values
BackendUserAuthenticationgetLanguageService()
protected
getLanguageService() : LanguageService
Return values
LanguageServicegetPreviewLanguages()
Returns the preview languages
protected
getPreviewLanguages(int $pageId) : array<string|int, mixed>
Parameters
- $pageId : int
Return values
array<string|int, mixed>getPreviewPresets()
Get available presets for page id.
protected
getPreviewPresets(int $pageId) : array<string|int, mixed>
Parameters
- $pageId : int
Return values
array<string|int, mixed>getShortcutTitle()
Returns the shortcut title for the current page.
protected
getShortcutTitle(int $pageId) : string
Parameters
- $pageId : int
Return values
stringgetTypeParameterIfSet()
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.
protected
getTypeParameterIfSet(int $pageId) : string
The method checks if a type is set for the given id and returns the additional GET string.
Parameters
- $pageId : int
Return values
stringisValidDoktype()
Verifies if doktype of given page is valid - not a folder / spacer / .
protected
isValidDoktype([int $pageId = 0 ]) : bool
..
Parameters
- $pageId : int = 0
Return values
boolregisterDocHeader()
protected
registerDocHeader(ModuleTemplate $view, int $pageId, int $languageId, string $targetUrl) : mixed
Parameters
- $view : ModuleTemplate
- $pageId : int
- $languageId : int
- $targetUrl : string