DrawingConfiguration

class \TYPO3\CMS\Backend\View\Drawing\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.

Table of Contents

Properties

$activeColumns  : array
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.
$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
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.
$showNewContentWizard  : bool
Whether or not to show the "new content" buttons that open the new content wizard, when rendering columns. Disabling this will disable the rendering of new content buttons both in column top and after each content element.

Methods

getActiveColumns()  : array
getDefaultLanguageBinding()  : bool
getLanguageColumns()  : array
getLanguageMode()  : bool
getSelectedLanguageId()  : int
getShowHidden()  : bool
getShowNewContentWizard()  : bool
setActiveColumns()  : void
setDefaultLanguageBinding()  : void
setLanguageColumns()  : void
setLanguageMode()  : void
setSelectedLanguageId()  : void
setShowHidden()  : void
setShowNewContentWizard()  : 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 $activeColumns = [1, 0, 2, 3]

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

$showNewContentWizard

Whether or not to show the "new content" buttons that open the new content wizard, when rendering columns. Disabling this will disable the rendering of new content buttons both in column top and after each content element.

protected bool $showNewContentWizard = true

Methods

getActiveColumns()

public getActiveColumns() : array

Return values

array

getDefaultLanguageBinding()

public getDefaultLanguageBinding() : bool

Return values

bool

getLanguageColumns()

public getLanguageColumns() : array

Return values

array

getLanguageMode()

public getLanguageMode() : bool

Return values

bool

getSelectedLanguageId()

public getSelectedLanguageId() : int

Return values

int

getShowHidden()

public getShowHidden() : bool

Return values

bool

getShowNewContentWizard()

public getShowNewContentWizard() : bool

Return values

bool

setActiveColumns()

public setActiveColumns(array $activeColumns) : void

Parameters

$activeColumns : array

setDefaultLanguageBinding()

public setDefaultLanguageBinding(bool $defaultLanguageBinding) : void

Parameters

$defaultLanguageBinding : bool

setLanguageColumns()

public setLanguageColumns(array $languageColumns) : void

Parameters

$languageColumns : array

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

setShowNewContentWizard()

public setShowNewContentWizard(bool $showNewContentWizard) : void

Parameters

$showNewContentWizard : bool
On this page