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.

Internal

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
$languageColumns  : array<string|int, mixed>
Key => "Language ID", Value "Label of language"
$pageViewMode  : PageViewMode
$selectedLanguageIds  : array<string|int, int>
Array of selected language IDs for multi-language comparison view
$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
getLanguageColumns()  : array<string|int, mixed>
getPrimaryLanguageId()  : int
Get the primary (first) selected language ID
getSelectedLanguageIds()  : array<string|int, int>
Get all selected language IDs
getShowHidden()  : bool
isLanguageComparisonMode()  : bool
setLanguageColumns()  : void
setSelectedLanguageIds()  : void
Set selected language IDs
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

$languageColumns

Key => "Language ID", Value "Label of language"

protected array<string|int, mixed> $languageColumns = []

$selectedLanguageIds

Array of selected language IDs for multi-language comparison view

protected array<string|int, int> $selectedLanguageIds = [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
bool

getActiveColumns()

public getActiveColumns() : array<string|int, mixed>
Return values
array<string|int, mixed>

getAllowInconsistentLanguageHandling()

public getAllowInconsistentLanguageHandling() : bool
Return values
bool

getLanguageColumns()

public getLanguageColumns() : array<string|int, mixed>
Return values
array<string|int, mixed>

getPrimaryLanguageId()

Get the primary (first) selected language ID

public getPrimaryLanguageId() : int
Return values
int

getSelectedLanguageIds()

Get all selected language IDs

public getSelectedLanguageIds() : array<string|int, int>
Return values
array<string|int, int>

getShowHidden()

public getShowHidden() : bool
Return values
bool

isLanguageComparisonMode()

public isLanguageComparisonMode() : bool
Return values
bool

setLanguageColumns()

public setLanguageColumns(array<string|int, mixed> $languageColumns) : void
Parameters
$languageColumns : array<string|int, mixed>

setSelectedLanguageIds()

Set selected language IDs

public setSelectedLanguageIds(array<string|int, int> $selectedLanguageIds) : void
Parameters
$selectedLanguageIds : array<string|int, int>

setShowHidden()

public setShowHidden(bool $showHidden) : void
Parameters
$showHidden : bool

shouldHideRestrictedColumns()

public shouldHideRestrictedColumns() : bool
Return values
bool

translateModeForTranslationsAllowed()

public translateModeForTranslationsAllowed() : bool
Return values
bool 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results