PageTsBackendLayoutDataProvider implements DataProviderInterface

This Provider adds Backend Layouts based on page TSconfig

= Example = mod { web_layout { BackendLayouts { example { title = Example config { backend_layout { colCount = 1 rowCount = 2 rows { 1 { columns { 1 { name = LLL:EXT:frontend/Resources/Private/Language/locallang_ttc.xlf:colPos.I.3 colPos = 3 colspan = 1 } } } 2 { columns { 1 { name = Main colPos = 0 colspan = 1 } } } } } } icon = content-container-columns-2 } } } }

Internal

Do not extend, change providers using $GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['BackendLayoutDataProvider']

Tags
todo:

Mark final in v13 and change protected to private.

Table of Contents

Interfaces

DataProviderInterface
Interface for classes which hook into BackendLayoutDataProvider to provide additional backend layouts from various sources.

Properties

$backendLayouts  : array<string|int, mixed>
Internal Backend Layout stack

Methods

addBackendLayouts()  : void
Adds backend layouts to the given backend layout collection.
getBackendLayout()  : BackendLayout|null
Gets a backend layout by (regular) identifier.
attachBackendLayout()  : mixed
Attach Backend Layout to internal Stack
createBackendLayout()  : BackendLayout
Creates a new backend layout using the given record data.
generateBackendLayoutFromTsConfig()  : mixed
Generates a Backend Layout from page TSconfig array
generateBackendLayouts()  : mixed
Generate the Backend Layout configs
getIconPath()  : string
Gets and sanitizes the icon path.
getPageTsConfig()  : array<string|int, mixed>
Gets page TSconfig from DataProviderContext if available from context, else fetch from BackendUtility by pageId.

Properties

$backendLayouts

Internal Backend Layout stack

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

Methods

getBackendLayout()

Gets a backend layout by (regular) identifier.

public getBackendLayout(string $identifier, int $pageId) : BackendLayout|null
Parameters
$identifier : string
$pageId : int
Return values
BackendLayout|null

attachBackendLayout()

Attach Backend Layout to internal Stack

protected attachBackendLayout([mixed $backendLayout = null ]) : mixed
Parameters
$backendLayout : mixed = null

createBackendLayout()

Creates a new backend layout using the given record data.

protected createBackendLayout(array<string|int, mixed> $data) : BackendLayout
Parameters
$data : array<string|int, mixed>
Return values
BackendLayout

generateBackendLayoutFromTsConfig()

Generates a Backend Layout from page TSconfig array

protected generateBackendLayoutFromTsConfig(string $identifier, array<string|int, mixed> $data) : mixed
Parameters
$identifier : string
$data : array<string|int, mixed>

generateBackendLayouts()

Generate the Backend Layout configs

protected generateBackendLayouts(DataProviderContext|null $dataProviderContext, int|null $pageId) : mixed
Parameters
$dataProviderContext : DataProviderContext|null
$pageId : int|null

getIconPath()

Gets and sanitizes the icon path.

protected getIconPath(string $icon) : string
Parameters
$icon : string

Name of the icon file

Return values
string

getPageTsConfig()

Gets page TSconfig from DataProviderContext if available from context, else fetch from BackendUtility by pageId.

protected getPageTsConfig(DataProviderContext|null $dataProviderContext, int|null $pageId) : array<string|int, mixed>
Parameters
$dataProviderContext : DataProviderContext|null
$pageId : int|null
Return values
array<string|int, mixed> 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results