TYPO3 CMS  TYPO3_7-6
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
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)
 
 getBackendLayout ($identifier, $pageId)
 

Protected Member Functions

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

Protected Attributes

 $backendLayouts = []
 
 $pageTsConfig = []
 
 $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 66 of file PageTsBackendLayoutDataProvider.php.

Member Function Documentation

◆ addBackendLayouts()

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

Implements TYPO3\CMS\Backend\View\BackendLayout\DataProviderInterface.

Definition at line 208 of file PageTsBackendLayoutDataProvider.php.

References TYPO3\CMS\Backend\View\BackendLayout\BackendLayoutCollection\add(), TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider\createBackendLayout(), and TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider\generateBackendLayouts().

◆ attachBackendLayout()

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

Attach Backend Layout to internal Stack

Parameters
mixed$backendLayout

Definition at line 196 of file PageTsBackendLayoutDataProvider.php.

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

◆ createBackendLayout()

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

Creates a new backend layout using the given record data.

Parameters
array$data
Returns
BackendLayout

Definition at line 241 of file PageTsBackendLayoutDataProvider.php.

References TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\create(), and TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider\getIconPath().

Referenced by TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider\addBackendLayouts(), and TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider\getBackendLayout().

◆ generateBackendLayoutFromTsConfig()

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

Generates a Backend Layout from PageTsConfig array

Returns
mixed

Definition at line 174 of file PageTsBackendLayoutDataProvider.php.

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

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

◆ generateBackendLayouts()

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

Generate the Backend Layout configs

Parameters
DataProviderContext$dataProviderContext
Returns
void

Definition at line 156 of file PageTsBackendLayoutDataProvider.php.

References TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider\$backendLayouts, TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider\$pageTsConfig, TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider\attachBackendLayout(), TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider\generateBackendLayoutFromTsConfig(), TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider\generatePageTsConfig(), and TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider\getPageTsConfig().

Referenced by TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider\addBackendLayouts(), and TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider\getBackendLayout().

◆ generatePageTsConfig()

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

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

Parameters
DataProviderContext$dataProviderContext
Returns
void

Definition at line 138 of file PageTsBackendLayoutDataProvider.php.

References TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider\$pageId, TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider\$pageTsConfig, TYPO3\CMS\Core\Utility\GeneralUtility\_GP(), TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider\getPageId(), TYPO3\CMS\Backend\Utility\BackendUtility\getPagesTSconfig(), and TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider\setPageTsConfig().

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

◆ getBackendLayout()

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

Gets a backend layout by (regular) identifier.

Parameters
string$identifier
int$pageId
Returns
NULL|BackendLayout

Implements TYPO3\CMS\Backend\View\BackendLayout\DataProviderInterface.

Definition at line 224 of file PageTsBackendLayoutDataProvider.php.

References TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider\$pageId, TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider\createBackendLayout(), TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider\generateBackendLayouts(), and TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider\setPageId().

◆ getIconPath()

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

Gets and sanitizes the icon path.

Parameters
string$iconName of the icon file
Returns
string

Definition at line 255 of file PageTsBackendLayoutDataProvider.php.

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

◆ getPageId()

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

Get PageId

Returns
int

Definition at line 126 of file PageTsBackendLayoutDataProvider.php.

References TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider\$pageId.

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

◆ getPageTsConfig()

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

Get PageTsConfig

Returns
array

Definition at line 105 of file PageTsBackendLayoutDataProvider.php.

References TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider\$pageTsConfig.

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

◆ setPageId()

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

Set PageId

Parameters
int$pageId
Returns
void

Definition at line 116 of file PageTsBackendLayoutDataProvider.php.

References TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider\$pageId.

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

◆ setPageTsConfig()

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

Set PageTsConfig

Parameters
array$pageTsConfig
Returns
void

Definition at line 95 of file PageTsBackendLayoutDataProvider.php.

References TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider\$pageTsConfig.

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

Member Data Documentation

◆ $backendLayouts

TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider::$backendLayouts = []
protected

Definition at line 73 of file PageTsBackendLayoutDataProvider.php.

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

◆ $pageId

TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider::$pageId = 0
protected

Definition at line 87 of file PageTsBackendLayoutDataProvider.php.

Referenced by TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider\generatePageTsConfig(), TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider\getBackendLayout(), TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider\getPageId(), and TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider\setPageId().

◆ $pageTsConfig

TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider::$pageTsConfig = []
protected

Definition at line 80 of file PageTsBackendLayoutDataProvider.php.

Referenced by TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider\generateBackendLayouts(), TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider\generatePageTsConfig(), TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider\getPageTsConfig(), and TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider\setPageTsConfig().