‪TYPO3CMS  9.5
TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider Class Reference
Inheritance diagram for TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider:
TYPO3\CMS\Backend\View\BackendLayout\DataProviderInterface

Public Member Functions

 addBackendLayouts (DataProviderContext $dataProviderContext, BackendLayoutCollection $backendLayoutCollection)
 
BackendLayout null getBackendLayout ($identifier, $pageId)
 

Protected Member Functions

 setPageTsConfig (array $pageTsConfig)
 
array getPageTsConfig ()
 
 setPageId ($pageId)
 
int getPageId ()
 
 generatePageTsConfig ($dataProviderContext=null)
 
 generateBackendLayouts ($dataProviderContext=null)
 
mixed generateBackendLayoutFromTsConfig ($identifier, $data)
 
 attachBackendLayout ($backendLayout=null)
 
BackendLayout createBackendLayout (array $data)
 
string getIconPath ($icon)
 

Protected Attributes

array $backendLayouts = array( )
 
array $pageTsConfig = array( )
 
int $pageId = 0
 

Detailed Description

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 } } } }

Definition at line 65 of file PageTsBackendLayoutDataProvider.php.

Member Function Documentation

◆ addBackendLayouts()

TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider::addBackendLayouts ( DataProviderContext  $dataProviderContext,
BackendLayoutCollection  $backendLayoutCollection 
)

◆ attachBackendLayout()

TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider::attachBackendLayout (   $backendLayout = null)
protected

Attach Backend Layout to internal Stack

Parameters
mixed$backendLayout

Definition at line 190 of file PageTsBackendLayoutDataProvider.php.

Referenced by TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider\generateBackendLayouts().

◆ createBackendLayout()

BackendLayout TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider::createBackendLayout ( array  $data)
protected

◆ generateBackendLayoutFromTsConfig()

mixed TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider::generateBackendLayoutFromTsConfig (   $identifier,
  $data 
)
protected

Generates a Backend Layout from PageTsConfig array

Parameters
string$identifier
array$data
Returns
‪mixed

Definition at line 168 of file PageTsBackendLayoutDataProvider.php.

References TYPO3\CMS\Core\Utility\ArrayUtility\flatten().

Referenced by TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider\generateBackendLayouts().

◆ generateBackendLayouts()

◆ generatePageTsConfig()

TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider::generatePageTsConfig (   $dataProviderContext = null)
protected

◆ getBackendLayout()

BackendLayout null TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider::getBackendLayout (   $identifier,
  $pageId 
)

◆ getIconPath()

string TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider::getIconPath (   $icon)
protected

Gets and sanitizes the icon path.

Parameters
string$icon‪Name of the icon file
Returns
‪string

Definition at line 248 of file PageTsBackendLayoutDataProvider.php.

Referenced by TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider\createBackendLayout().

◆ getPageId()

int TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider::getPageId ( )
protected

◆ getPageTsConfig()

array TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider::getPageTsConfig ( )
protected

◆ setPageId()

TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider::setPageId (   $pageId)
protected

◆ setPageTsConfig()

TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider::setPageTsConfig ( array  $pageTsConfig)
protected

Member Data Documentation

◆ $backendLayouts

array TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider::$backendLayouts = array( )
protected

◆ $pageId

◆ $pageTsConfig