PageLayoutContext
Page Module specific rendering context.
Extends generic PageContext with module-specific rendering configuration for the page module (web_layout).
This context provides:
- Generic page data (via delegation to PageContext)
- Backend layout configuration
- Drawing configuration
- Content type labels
- Content fetcher
Table of Contents
Properties
- $backendLayout : BackendLayout
- $contentFetcher : ContentFetcher
- $contentTypeLabels : array<string|int, mixed>
- Array of content type labels. Key is CType, value is either a plain text label or an LLL:EXT:... reference to a specific label.
- $drawingConfiguration : DrawingConfiguration
- $itemLabels : array<string|int, mixed>
- Labels for columns, in format of TCA select options. Numerically indexed array of numerically indexed value arrays, with each sub-array containing at least two values and one optional third value:
- $localizedPageRecord : array<string|int, mixed>|null
- $pageContext : PageContext
- $recordIdentityMap : RecordIdentityMap
- $request : ServerRequestInterface
- $siteLanguage : SiteLanguage
- $siteLanguages : array<string|int, SiteLanguage>
Methods
- __construct() : mixed
- cloneForLanguage() : self
- getAllowNewContent() : bool
- getBackendLayout() : BackendLayout
- getBackendUser() : BackendUserAuthentication
- getContentTypeLabels() : array<string|int, mixed>
- getCurrentRequest() : ServerRequestInterface
- getDrawingConfiguration() : DrawingConfiguration
- getItemLabels() : array<string|int, mixed>
- getLanguageInformation() : PageLanguageInformation
- getLanguageMode() : string
- getLanguageModeIdentifier() : string
- getLanguageModeLabelClass() : string
- getLanguagesToShow() : array<string|int, SiteLanguage>
- getLocalizedPageRecord() : array<string|int, mixed>|null
- getLocalizedPageTitle() : string
- getPageContext() : PageContext
- getPageId() : int
- getPageRecord() : array<string|int, mixed>
- getPrimaryLanguageId() : int
- getRecordIdentityMap() : RecordIdentityMap
- getReturnUrl() : string
- getSelectedLanguageIds() : array<string|int, mixed>
- getSite() : SiteInterface
- getSiteLanguage() : SiteLanguage
- getSiteLanguages() : array<string|int, SiteLanguage>
- hasMultiLanguages() : bool
- isPageEditable() : bool
- getLanguageService() : LanguageService
- setSiteLanguage() : void
Properties
$backendLayout read-only
protected
BackendLayout
$backendLayout
$contentFetcher
protected
ContentFetcher
$contentFetcher
$contentTypeLabels
Array of content type labels. Key is CType, value is either a plain text label or an LLL:EXT:... reference to a specific label.
protected
array<string|int, mixed>
$contentTypeLabels
= []
$drawingConfiguration read-only
protected
DrawingConfiguration
$drawingConfiguration
$itemLabels
Labels for columns, in format of TCA select options. Numerically indexed array of numerically indexed value arrays, with each sub-array containing at least two values and one optional third value:
protected
array<string|int, mixed>
$itemLabels
= []
- label (hardcoded or LLL:EXT:... reference. MANDATORY)
- value (colPos of column. MANDATORY)
- icon (icon name or file reference. OPTIONAL)
$localizedPageRecord
protected
array<string|int, mixed>|null
$localizedPageRecord
= null
$pageContext read-only
protected
PageContext
$pageContext
$recordIdentityMap
protected
RecordIdentityMap
$recordIdentityMap
$request read-only
protected
ServerRequestInterface
$request
$siteLanguage
protected
SiteLanguage
$siteLanguage
$siteLanguages
protected
array<string|int, SiteLanguage>
$siteLanguages
= []
Methods
__construct()
public
__construct(PageContext $pageContext, BackendLayout $backendLayout, DrawingConfiguration $drawingConfiguration, ServerRequestInterface $request) : mixed
Parameters
- $pageContext : PageContext
- $backendLayout : BackendLayout
- $drawingConfiguration : DrawingConfiguration
- $request : ServerRequestInterface
cloneForLanguage()
public
cloneForLanguage(SiteLanguage $language) : self
Parameters
- $language : SiteLanguage
Return values
selfgetAllowNewContent()
public
getAllowNewContent() : bool
Return values
boolgetBackendLayout()
public
getBackendLayout() : BackendLayout
Return values
BackendLayoutgetBackendUser()
public
getBackendUser() : BackendUserAuthentication
Return values
BackendUserAuthenticationgetContentTypeLabels()
public
getContentTypeLabels() : array<string|int, mixed>
Return values
array<string|int, mixed>getCurrentRequest()
public
getCurrentRequest() : ServerRequestInterface
Return values
ServerRequestInterfacegetDrawingConfiguration()
public
getDrawingConfiguration() : DrawingConfiguration
Return values
DrawingConfigurationgetItemLabels()
public
getItemLabels() : array<string|int, mixed>
Return values
array<string|int, mixed>getLanguageInformation()
public
getLanguageInformation() : PageLanguageInformation
Return values
PageLanguageInformationgetLanguageMode()
public
getLanguageMode() : string
Return values
stringgetLanguageModeIdentifier()
public
getLanguageModeIdentifier() : string
Return values
stringgetLanguageModeLabelClass()
public
getLanguageModeLabelClass() : string
Return values
stringgetLanguagesToShow()
public
getLanguagesToShow() : array<string|int, SiteLanguage>
Return values
array<string|int, SiteLanguage>getLocalizedPageRecord()
public
getLocalizedPageRecord() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|nullgetLocalizedPageTitle()
public
getLocalizedPageTitle() : string
Return values
stringgetPageContext()
public
getPageContext() : PageContext
Return values
PageContextgetPageId()
public
getPageId() : int
Return values
intgetPageRecord()
public
getPageRecord() : array<string|int, mixed>
Return values
array<string|int, mixed>getPrimaryLanguageId()
public
getPrimaryLanguageId() : int
Return values
intgetRecordIdentityMap()
public
getRecordIdentityMap() : RecordIdentityMap
Return values
RecordIdentityMapgetReturnUrl()
public
getReturnUrl() : string
Return values
stringgetSelectedLanguageIds()
public
getSelectedLanguageIds() : array<string|int, mixed>
Return values
array<string|int, mixed>getSite()
public
getSite() : SiteInterface
Return values
SiteInterfacegetSiteLanguage()
public
getSiteLanguage([int|null $languageId = null ]) : SiteLanguage
Parameters
- $languageId : int|null = null
Return values
SiteLanguagegetSiteLanguages()
public
getSiteLanguages() : array<string|int, SiteLanguage>
Return values
array<string|int, SiteLanguage>hasMultiLanguages()
public
hasMultiLanguages() : bool
Return values
boolisPageEditable()
public
isPageEditable() : bool
Return values
boolgetLanguageService()
protected
getLanguageService() : LanguageService
Return values
LanguageServicesetSiteLanguage()
protected
setSiteLanguage(SiteLanguage $siteLanguage) : void
Parameters
- $siteLanguage : SiteLanguage