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

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.
$allowInconsistentLanguageHandling  : bool
Corresponds to web.layout.allowInconsistentLanguageHandling TSconfig property
$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"
$languageMode  : bool
If TRUE, indicates that the current rendering method shows multiple languages (e.g. the "page" module is set in "Languages" mode.
$selectedLanguageId  : int
$showHidden  : bool
Whether or not to show hidden records when rendering column contents.

Methods

getActiveColumns()  : array<string|int, mixed>
getAllowInconsistentLanguageHandling()  : bool
getDefaultLanguageBinding()  : bool
getLanguageColumns()  : array<string|int, mixed>
getLanguageMode()  : bool
getSelectedLanguageId()  : int
getShowHidden()  : bool
setActiveColumns()  : void
setAllowInconsistentLanguageHandling()  : void
setDefaultLanguageBinding()  : void
setLanguageColumns()  : void
setLanguageMode()  : void
setSelectedLanguageId()  : void
setShowHidden()  : void
getBackendUser()  : BackendUserAuthentication
getLanguageService()  : LanguageService

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]

$allowInconsistentLanguageHandling

Corresponds to web.layout.allowInconsistentLanguageHandling TSconfig property

protected bool $allowInconsistentLanguageHandling = false

$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 = true

$languageColumns

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

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

$languageMode

If TRUE, indicates that the current rendering method shows multiple languages (e.g. the "page" module is set in "Languages" mode.

protected bool $languageMode = false

$selectedLanguageId

protected int $selectedLanguageId = 0

$showHidden

Whether or not to show hidden records when rendering column contents.

protected bool $showHidden = true

Methods

getActiveColumns()

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

getAllowInconsistentLanguageHandling()

public getAllowInconsistentLanguageHandling() : bool
Return values
bool

getDefaultLanguageBinding()

public getDefaultLanguageBinding() : bool
Return values
bool

getLanguageColumns()

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

getLanguageMode()

public getLanguageMode() : bool
Return values
bool

getSelectedLanguageId()

public getSelectedLanguageId() : int
Return values
int

getShowHidden()

public getShowHidden() : bool
Return values
bool

setActiveColumns()

public setActiveColumns(array<string|int, mixed> $activeColumns) : void
Parameters
$activeColumns : array<string|int, mixed>

setAllowInconsistentLanguageHandling()

public setAllowInconsistentLanguageHandling(bool $allowInconsistentLanguageHandling) : void
Parameters
$allowInconsistentLanguageHandling : bool

setDefaultLanguageBinding()

public setDefaultLanguageBinding(bool $defaultLanguageBinding) : void
Parameters
$defaultLanguageBinding : bool

setLanguageColumns()

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

setLanguageMode()

public setLanguageMode(bool $languageMode) : void
Parameters
$languageMode : bool

setSelectedLanguageId()

public setSelectedLanguageId(int $selectedLanguageId) : void
Parameters
$selectedLanguageId : int

setShowHidden()

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

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results