BackendLayoutView

class \TYPO3\CMS\Backend\View\BackendLayoutView

Implements
SingletonInterface

Backend layout for CMS

Table of Contents

Interfaces

SingletonInterface
"empty" interface for singletons (marker interface pattern)

Properties

$selectedBackendLayout  : array
$selectedCombinedIdentifier  : array

Methods

__construct()  : mixed
Create this object and initialize data providers.
addBackendLayoutItems()  : mixed
Gets backend layout items to be shown in the forms engine.
colPosListItemProcFunc()  : mixed
Gets colPos items to be shown in the forms engine.
getBackendLayoutForPage()  : BackendLayout
Get the BackendLayout object and parse the structure based on the UserTSconfig
getColPosListItemsParsed()  : array
Gets the list of available columns for a given page id
getDefaultColumnLayout()  : string
Get default columns layout
getSelectedBackendLayout()  : array|null
Gets the selected backend layout structure as an array
getSelectedCombinedIdentifier()  : bool|string
Returns the backend layout which should be used for this page.
parseStructure()  : array
addColPosListLayoutItems()  : array
Adds items to a colpos list
addItems()  : array
Merges items into an item-array, optionally with an icon example: TCEFORM.pages.doktype.addItems.13 = My Label TCEFORM.pages.doktype.addItems.13.icon = EXT:t3skin/icons/gfx/i/pages.gif
createDataProviderContext()  : DataProviderContext
determinePageId()  : int|false
Determines the page id for a given record of a database table.
getColumnName()  : string
Get column name from colPos item structure
getIdentifiersToBeExcluded()  : array
Gets backend layout identifiers to be excluded
getLanguageService()  : LanguageService
getPage()  : array|false|null
Gets a page record.
getRootLine()  : array
Gets the page root-line.

Properties

$selectedBackendLayout

protected array $selectedBackendLayout = []

$selectedCombinedIdentifier

protected array $selectedCombinedIdentifier = []

Methods

addBackendLayoutItems()

Gets backend layout items to be shown in the forms engine.

public addBackendLayoutItems(array &$parameters) : mixed

This method is called as "itemsProcFunc" with the accordant context for pages.backend_layout and pages.backend_layout_next_level. Also used in the info module, since we need those items with the appropriate labels and backend layout identifiers there, too.

Parameters

$parameters : array

Tags

todo

This method should return the items array instead of using the whole parameters array as reference. This has to be adjusted, as soon as the itemsProcFunc functionality is changed in this regard.

colPosListItemProcFunc()

Gets colPos items to be shown in the forms engine.

public colPosListItemProcFunc(array $parameters) : mixed

This method is called as "itemsProcFunc" with the accordant context for tt_content.colPos.

Parameters

$parameters : array

getBackendLayoutForPage()

Get the BackendLayout object and parse the structure based on the UserTSconfig

public getBackendLayoutForPage(int $pageId) : BackendLayout

Parameters

$pageId : int

Return values

BackendLayout

getColPosListItemsParsed()

Gets the list of available columns for a given page id

public getColPosListItemsParsed(int $id) : array

Parameters

$id : int

Return values

array —

$tcaItems

getDefaultColumnLayout()

Get default columns layout

public static getDefaultColumnLayout() : string

Tags

static

Return values

string —

Default four column layout

getSelectedBackendLayout()

Gets the selected backend layout structure as an array

public getSelectedBackendLayout(int $pageId) : array|null

Parameters

$pageId : int

Return values

array|null —

$backendLayout

getSelectedCombinedIdentifier()

Returns the backend layout which should be used for this page.

public getSelectedCombinedIdentifier(int $pageId) : bool|string

Parameters

$pageId : int

Return values

bool|string —

Identifier of the backend layout to be used, or FALSE if none

addColPosListLayoutItems()

Adds items to a colpos list

protected addColPosListLayoutItems(int $pageId, array $items) : array

Parameters

$pageId : int
$items : array

Return values

array

addItems()

Merges items into an item-array, optionally with an icon example: TCEFORM.pages.doktype.addItems.13 = My Label TCEFORM.pages.doktype.addItems.13.icon = EXT:t3skin/icons/gfx/i/pages.gif

protected addItems(array $items, array $iArray) : array

Parameters

$items : array

The existing item array

$iArray : array

An array of items to add. NOTICE: The keys are mapped to values, and the values and mapped to be labels. No possibility of adding an icon.

Return values

array —

The updated $item array

determinePageId()

Determines the page id for a given record of a database table.

protected determinePageId(string $tableName, array $data) : int|false

Parameters

$tableName : string
$data : array

Return values

int|false —

Returns page id or false on error

getColumnName()

Get column name from colPos item structure

protected getColumnName(array $column) : string

Parameters

$column : array

Return values

string

getIdentifiersToBeExcluded()

Gets backend layout identifiers to be excluded

protected getIdentifiersToBeExcluded(array $pageTSconfig) : array

Parameters

$pageTSconfig : array

Return values

array

getPage()

Gets a page record.

protected getPage(int $pageId) : array|false|null

Parameters

$pageId : int

Return values

array|false|null

getRootLine()

Gets the page root-line.

protected getRootLine(int $pageId) : array

Parameters

$pageId : int

Return values

array
On this page