BackendLayoutView implements SingletonInterface

Backend layout for CMS

Internal

This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.

Table of Contents

Interfaces

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

Properties

$selectedBackendLayout  : array<string|int, mixed>
$selectedCombinedIdentifier  : array<string|int, mixed>

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<string|int, mixed>
Gets the list of available columns for a given page id
getDefaultColumnLayout()  : string
Get default columns layout
getSelectedBackendLayout()  : array<string|int, mixed>|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<string|int, mixed>
addColPosListLayoutItems()  : array<string|int, mixed>
Adds items to a colpos list
addItems()  : array<string|int, mixed>
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<string|int, mixed>
Gets backend layout identifiers to be excluded
getLanguageService()  : LanguageService
getPage()  : array<string|int, mixed>|false|null
Gets a page record.
getRootLine()  : array<string|int, mixed>
Gets the page root-line.

Properties

$selectedBackendLayout

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

$selectedCombinedIdentifier

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

Methods

addBackendLayoutItems()

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

public addBackendLayoutItems(array<string|int, mixed> &$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<string|int, mixed>
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<string|int, mixed> $parameters) : mixed

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

Parameters
$parameters : array<string|int, mixed>

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<string|int, mixed>
Parameters
$id : int
Return values
array<string|int, mixed> —

$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<string|int, mixed>|null
Parameters
$pageId : int
Return values
array<string|int, mixed>|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

parseStructure()

public parseStructure(BackendLayout $backendLayout) : array<string|int, mixed>
Parameters
$backendLayout : BackendLayout
Internal
Return values
array<string|int, mixed>

addColPosListLayoutItems()

Adds items to a colpos list

protected addColPosListLayoutItems(int $pageId, array<string|int, mixed> $items) : array<string|int, mixed>
Parameters
$pageId : int
$items : array<string|int, mixed>
Return values
array<string|int, mixed>

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<string|int, mixed> $items, array<string|int, mixed> $iArray) : array<string|int, mixed>
Parameters
$items : array<string|int, mixed>

The existing item array

$iArray : array<string|int, mixed>

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.

Internal
Return values
array<string|int, mixed> —

The updated $item array

determinePageId()

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

protected determinePageId(string $tableName, array<string|int, mixed> $data) : int|false
Parameters
$tableName : string
$data : array<string|int, mixed>
Return values
int|false —

Returns page id or false on error

getColumnName()

Get column name from colPos item structure

protected getColumnName(array<string|int, mixed> $column) : string
Parameters
$column : array<string|int, mixed>
Return values
string

getIdentifiersToBeExcluded()

Gets backend layout identifiers to be excluded

protected getIdentifiersToBeExcluded(array<string|int, mixed> $pageTSconfig) : array<string|int, mixed>
Parameters
$pageTSconfig : array<string|int, mixed>
Return values
array<string|int, mixed>

getPage()

Gets a page record.

protected getPage(int $pageId) : array<string|int, mixed>|false|null
Parameters
$pageId : int
Return values
array<string|int, mixed>|false|null

getRootLine()

Gets the page root-line.

protected getRootLine(int $pageId) : array<string|int, mixed>
Parameters
$pageId : int
Return values
array<string|int, mixed> 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results