DrawingConfiguration
Drawing Configuration
Attached to BackendLayout as storage for configuration options which determine how a page layout is rendered. Contains settings for active language, show-hidden, site languages etc. and returns TCA labels for tt_content fields and CTypes.
Corresponds to legacy public properties from PageLayoutView.
this is experimental and subject to change in TYPO3 v10 / v11
Table of Contents
Properties
- $activeColumns : array<string|int, mixed>
- An array list of currently active columns. Only column identifiers (colPos value) which are contained in this array will be rendered in the page module.
- $allowCopyModeForTranslations : bool
- Whether or not to allow the copy mode for translations
- $allowInconsistentLanguageHandling : bool
- Corresponds to web.layout.allowInconsistentLanguageHandling TSconfig property
- $allowTranslateModeForTranslations : bool
- Whether or not to allow the translate mode for translations
- $defaultLanguageBinding : bool
- Determines whether rendering should happen with a visually aligned connection between default language and translation. When rendered with this flag enabled, any translated versions are vertically aligned so they are rendered in the same visual row as the original.
- $languageColumns : array<string|int, mixed>
- Key => "Language ID", Value "Label of language"
- $pageViewMode : PageViewMode
- $selectedLanguageId : int
- $shouldHideRestrictedColumns : bool
- $showHidden : bool
- Whether or not to show hidden records when rendering column contents.
Methods
- copyModeForTranslationsAllowed() : bool
- create() : self
- getActiveColumns() : array<string|int, mixed>
- getAllowInconsistentLanguageHandling() : bool
- getDefaultLanguageBinding() : bool
- getLanguageColumns() : array<string|int, mixed>
- getSelectedLanguageId() : int
- getShowHidden() : bool
- isLanguageComparisonMode() : bool
- setLanguageColumns() : void
- setSelectedLanguageId() : void
- setShowHidden() : void
- shouldHideRestrictedColumns() : bool
- translateModeForTranslationsAllowed() : bool
Properties
$activeColumns
An array list of currently active columns. Only column identifiers (colPos value) which are contained in this array will be rendered in the page module.
protected
array<string|int, mixed>
$activeColumns
= [1, 0, 2, 3]
$allowCopyModeForTranslations
Whether or not to allow the copy mode for translations
protected
bool
$allowCopyModeForTranslations
$allowInconsistentLanguageHandling
Corresponds to web.layout.allowInconsistentLanguageHandling TSconfig property
protected
bool
$allowInconsistentLanguageHandling
$allowTranslateModeForTranslations
Whether or not to allow the translate mode for translations
protected
bool
$allowTranslateModeForTranslations
$defaultLanguageBinding
Determines whether rendering should happen with a visually aligned connection between default language and translation. When rendered with this flag enabled, any translated versions are vertically aligned so they are rendered in the same visual row as the original.
protected
bool
$defaultLanguageBinding
$languageColumns
Key => "Language ID", Value "Label of language"
protected
array<string|int, mixed>
$languageColumns
= []
$pageViewMode
protected
PageViewMode
$pageViewMode
$selectedLanguageId
protected
int
$selectedLanguageId
= 0
$shouldHideRestrictedColumns
protected
bool
$shouldHideRestrictedColumns
$showHidden
Whether or not to show hidden records when rendering column contents.
protected
bool
$showHidden
= true
Methods
copyModeForTranslationsAllowed()
public
copyModeForTranslationsAllowed() : bool
Return values
boolcreate()
public
static create(BackendLayout $backendLayout, array<string|int, mixed> $pageTsConfig, PageViewMode $pageViewMode) : self
Parameters
- $backendLayout : BackendLayout
- $pageTsConfig : array<string|int, mixed>
- $pageViewMode : PageViewMode
Return values
selfgetActiveColumns()
public
getActiveColumns() : array<string|int, mixed>
Return values
array<string|int, mixed>getAllowInconsistentLanguageHandling()
public
getAllowInconsistentLanguageHandling() : bool
Return values
boolgetDefaultLanguageBinding()
public
getDefaultLanguageBinding() : bool
Return values
boolgetLanguageColumns()
public
getLanguageColumns() : array<string|int, mixed>
Return values
array<string|int, mixed>getSelectedLanguageId()
public
getSelectedLanguageId() : int
Return values
intgetShowHidden()
public
getShowHidden() : bool
Return values
boolisLanguageComparisonMode()
public
isLanguageComparisonMode() : bool
Return values
boolsetLanguageColumns()
public
setLanguageColumns(array<string|int, mixed> $languageColumns) : void
Parameters
- $languageColumns : array<string|int, mixed>
setSelectedLanguageId()
public
setSelectedLanguageId(int $selectedLanguageId) : void
Parameters
- $selectedLanguageId : int
setShowHidden()
public
setShowHidden(bool $showHidden) : void
Parameters
- $showHidden : bool
shouldHideRestrictedColumns()
public
shouldHideRestrictedColumns() : bool
Return values
booltranslateModeForTranslationsAllowed()
public
translateModeForTranslationsAllowed() : bool