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.
$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
Key => "Language ID", Value "Label of language"
$pageViewMode  : PageViewMode
$selectedLanguageIds  : 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
getAllowInconsistentLanguageHandling()  : bool
getLanguageColumns()  : array
getPrimaryLanguageId()  : int
Get the primary (first) selected language ID
getSelectedLanguageIds()  : 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 $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 $languageColumns = []

$selectedLanguageIds

Array of selected language IDs for multi-language comparison view

protected int[] $selectedLanguageIds = [\TYPO3\CMS\Core\Schema\LanguageMarker::DEFAULT_LANGUAGE]

$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

Return values

array

getAllowInconsistentLanguageHandling()

public getAllowInconsistentLanguageHandling() : bool

Return values

bool

getLanguageColumns()

public getLanguageColumns() : array

Return values

array

getPrimaryLanguageId()

Get the primary (first) selected language ID

public getPrimaryLanguageId() : int

Return values

int

getSelectedLanguageIds()

Get all selected language IDs

public getSelectedLanguageIds() : int[]

Return values

int[]

getShowHidden()

public getShowHidden() : bool

Return values

bool

isLanguageComparisonMode()

public isLanguageComparisonMode() : bool

Return values

bool

setLanguageColumns()

public setLanguageColumns(array $languageColumns) : void

Parameters

$languageColumns : array

setSelectedLanguageIds()

Set selected language IDs

public setSelectedLanguageIds(int[] $selectedLanguageIds) : void

Parameters

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