PageTsBackendLayoutDataProvider implements DataProviderInterface

This Provider adds Backend Layouts based on PageTsConfig

= 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 = EXT:example_extension/Resources/Public/Images/BackendLayouts/default.gif } } } }

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
$pageId  : int
PageId
$pageTsConfig  : array<string|int, mixed>
PageTs Config

Methods

addBackendLayouts()  : mixed
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 PageTsConfig array
generateBackendLayouts()  : mixed
Generate the Backend Layout configs
generatePageTsConfig()  : mixed
Gets PageTsConfig from DataProviderContext if available, if not it will be generated for the current Page.
getIconPath()  : string
Gets and sanitizes the icon path.
getPageId()  : int
Get PageId
getPageTsConfig()  : array<string|int, mixed>
Get PageTsConfig
setPageId()  : mixed
Set PageId
setPageTsConfig()  : mixed
Set PageTsConfig

Properties

$backendLayouts

Internal Backend Layout stack

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

$pageTsConfig

PageTs Config

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

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 PageTsConfig array

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

generatePageTsConfig()

Gets PageTsConfig from DataProviderContext if available, if not it will be generated for the current Page.

protected generatePageTsConfig([DataProviderContext $dataProviderContext = null ]) : mixed
Parameters
$dataProviderContext : DataProviderContext = null

getIconPath()

Gets and sanitizes the icon path.

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

Name of the icon file

Return values
string

getPageId()

Get PageId

protected getPageId() : int
Return values
int

getPageTsConfig()

Get PageTsConfig

protected getPageTsConfig() : array<string|int, mixed>
Return values
array<string|int, mixed>

setPageId()

Set PageId

protected setPageId(int $pageId) : mixed
Parameters
$pageId : int

setPageTsConfig()

Set PageTsConfig

protected setPageTsConfig(array<string|int, mixed> $pageTsConfig) : mixed
Parameters
$pageTsConfig : array<string|int, mixed> 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results