TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration Class Reference

Public Member Functions
	getSelectedLanguageId ()
	setSelectedLanguageId (int $selectedLanguageId)
	getAllowInconsistentLanguageHandling ()
	getDefaultLanguageBinding ()
	isLanguageComparisonMode ()
	getLanguageColumns ()
	setLanguageColumns (array $languageColumns)
	getShowHidden ()
	setShowHidden (bool $showHidden)
	getActiveColumns ()
	translateModeForTranslationsAllowed ()
	copyModeForTranslationsAllowed ()
	shouldHideRestrictedColumns ()

Static Public Member Functions
static	create (BackendLayout $backendLayout, array $pageTsConfig, PageViewMode $pageViewMode)

Protected Attributes
int	$selectedLanguageId = 0
bool	$allowInconsistentLanguageHandling
bool	$defaultLanguageBinding
array	$languageColumns = []
bool	$showHidden = true
array	$activeColumns = [1, 0, 2, 3]
bool	$allowTranslateModeForTranslations
bool	$allowCopyModeForTranslations
bool	$shouldHideRestrictedColumns
PageViewMode	$pageViewMode

Detailed Description

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

Definition at line 36 of file DrawingConfiguration.php.

Member Function Documentation

copyModeForTranslationsAllowed()

TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration::copyModeForTranslationsAllowed

(

)

Definition at line 163 of file DrawingConfiguration.php.

References TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration\$allowCopyModeForTranslations.

create()

static TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration::create ( BackendLayout  $backendLayout, array  $pageTsConfig, PageViewMode  $pageViewMode  )

static

Definition at line 84 of file DrawingConfiguration.php.

References TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration\$pageViewMode, TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\getColumnPositionNumbers(), and TYPO3\CMS\Core\Utility\GeneralUtility\intExplode().

Referenced by TYPO3\CMS\Backend\Controller\PageLayoutController\createPageLayoutContext().

getActiveColumns()

TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration::getActiveColumns

(

)

Definition at line 153 of file DrawingConfiguration.php.

References TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration\$activeColumns.

getAllowInconsistentLanguageHandling()

TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration::getAllowInconsistentLanguageHandling

(

)

Definition at line 115 of file DrawingConfiguration.php.

References TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration\$allowInconsistentLanguageHandling.

getDefaultLanguageBinding()

TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration::getDefaultLanguageBinding

(

)

Definition at line 120 of file DrawingConfiguration.php.

References TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration\$defaultLanguageBinding.

getLanguageColumns()

TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration::getLanguageColumns

(

)

Definition at line 130 of file DrawingConfiguration.php.

References TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration\$languageColumns.

getSelectedLanguageId()

TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration::getSelectedLanguageId

(

)

Definition at line 105 of file DrawingConfiguration.php.

References TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration\$selectedLanguageId.

getShowHidden()

TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration::getShowHidden

(

)

Definition at line 143 of file DrawingConfiguration.php.

References TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration\$showHidden.

isLanguageComparisonMode()

TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration::isLanguageComparisonMode

(

)

Definition at line 125 of file DrawingConfiguration.php.

References TYPO3\CMS\Backend\View\LanguageComparisonView.

Referenced by TYPO3\CMS\Backend\Controller\PageLayoutController\getNumberOfHiddenElements().

setLanguageColumns()

TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration::setLanguageColumns

(

array

$languageColumns

)

Definition at line 138 of file DrawingConfiguration.php.

References TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration\$languageColumns.

setSelectedLanguageId()

TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration::setSelectedLanguageId

(

int

$selectedLanguageId

)

Definition at line 110 of file DrawingConfiguration.php.

References TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration\$selectedLanguageId.

setShowHidden()

TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration::setShowHidden

(

bool

$showHidden

)

Definition at line 148 of file DrawingConfiguration.php.

References TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration\$showHidden.

shouldHideRestrictedColumns()

TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration::shouldHideRestrictedColumns

(

)

Definition at line 168 of file DrawingConfiguration.php.

References TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration\$shouldHideRestrictedColumns.

translateModeForTranslationsAllowed()

TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration::translateModeForTranslationsAllowed

(

)

Definition at line 158 of file DrawingConfiguration.php.

References TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration\$allowTranslateModeForTranslations.

Member Data Documentation

$activeColumns

array TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration::$activeColumns = [1, 0, 2, 3]

protected

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.

Definition at line 68 of file DrawingConfiguration.php.

Referenced by TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration\getActiveColumns().

$allowCopyModeForTranslations

bool TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration::$allowCopyModeForTranslations

protected

Whether or not to allow the copy mode for translations

Definition at line 78 of file DrawingConfiguration.php.

Referenced by TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration\copyModeForTranslationsAllowed().

$allowInconsistentLanguageHandling

bool TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration::$allowInconsistentLanguageHandling

protected

Corresponds to web.layout.allowInconsistentLanguageHandling TSconfig property

Definition at line 43 of file DrawingConfiguration.php.

Referenced by TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration\getAllowInconsistentLanguageHandling().

$allowTranslateModeForTranslations

bool TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration::$allowTranslateModeForTranslations

protected

Whether or not to allow the translate mode for translations

Definition at line 73 of file DrawingConfiguration.php.

Referenced by TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration\translateModeForTranslationsAllowed().

$defaultLanguageBinding

bool TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration::$defaultLanguageBinding

protected

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.

Definition at line 51 of file DrawingConfiguration.php.

Referenced by TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration\getDefaultLanguageBinding().

$languageColumns

array TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration::$languageColumns = []

protected

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

Definition at line 56 of file DrawingConfiguration.php.

Referenced by TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration\getLanguageColumns(), and TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration\setLanguageColumns().

$pageViewMode

PageViewMode TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration::$pageViewMode

protected

Definition at line 82 of file DrawingConfiguration.php.

Referenced by TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration\create().

$selectedLanguageId

int TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration::$selectedLanguageId = 0

protected

Definition at line 38 of file DrawingConfiguration.php.

Referenced by TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration\getSelectedLanguageId(), and TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration\setSelectedLanguageId().

$shouldHideRestrictedColumns

bool TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration::$shouldHideRestrictedColumns

protected

Definition at line 80 of file DrawingConfiguration.php.

Referenced by TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration\shouldHideRestrictedColumns().

$showHidden

bool TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration::$showHidden = true

protected

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

Definition at line 61 of file DrawingConfiguration.php.

Referenced by TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration\getShowHidden(), and TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration\setShowHidden().