PageTsBackendLayoutDataProvider Class Reference

TYPO3 7.6

Inheritance diagram for PageTsBackendLayoutDataProvider:

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 = array()

	$pageTsConfig = array()

	$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	(	DataProviderContext	$dataProviderContext,
		BackendLayoutCollection	$backendLayoutCollection
	)

Parameters

DataProviderContext	$dataProviderContext
BackendLayoutCollection	$backendLayoutCollection

Returns: void

Implements DataProviderInterface.

Definition at line 208 of file PageTsBackendLayoutDataProvider.php.

References BackendLayoutCollection\add(), PageTsBackendLayoutDataProvider\createBackendLayout(), and PageTsBackendLayoutDataProvider\generateBackendLayouts().

attachBackendLayout ( $backendLayout = null )

protected

Attach Backend Layout to internal Stack

Parameters

mixed $backendLayout

Definition at line 196 of file PageTsBackendLayoutDataProvider.php.

Referenced by PageTsBackendLayoutDataProvider\generateBackendLayouts().

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 BackendLayout\create(), and PageTsBackendLayoutDataProvider\getIconPath().

Referenced by PageTsBackendLayoutDataProvider\addBackendLayouts(), and PageTsBackendLayoutDataProvider\getBackendLayout().

generateBackendLayoutFromTsConfig	(		$identifier,
			$data
	)

protected

Generates a Backend Layout from PageTsConfig array

Returns: mixed

Definition at line 174 of file PageTsBackendLayoutDataProvider.php.

Referenced by PageTsBackendLayoutDataProvider\generateBackendLayouts().

generateBackendLayouts ( $dataProviderContext = null )

protected

Generate the Backend Layout configs

Parameters

DataProviderContext $dataProviderContext

Returns: void

Definition at line 156 of file PageTsBackendLayoutDataProvider.php.

References PageTsBackendLayoutDataProvider\$backendLayouts, PageTsBackendLayoutDataProvider\$pageTsConfig, PageTsBackendLayoutDataProvider\attachBackendLayout(), PageTsBackendLayoutDataProvider\generateBackendLayoutFromTsConfig(), PageTsBackendLayoutDataProvider\generatePageTsConfig(), and PageTsBackendLayoutDataProvider\getPageTsConfig().

Referenced by PageTsBackendLayoutDataProvider\addBackendLayouts(), and PageTsBackendLayoutDataProvider\getBackendLayout().

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 PageTsBackendLayoutDataProvider\$pageId, PageTsBackendLayoutDataProvider\$pageTsConfig, GeneralUtility\_GP(), PageTsBackendLayoutDataProvider\getPageId(), BackendUtility\getPagesTSconfig(), and PageTsBackendLayoutDataProvider\setPageTsConfig().

Referenced by PageTsBackendLayoutDataProvider\generateBackendLayouts().

getBackendLayout	(		$identifier,
			$pageId
	)

Gets a backend layout by (regular) identifier.

Parameters

string	$identifier
int	$pageId

Returns: NULL|BackendLayout

Implements DataProviderInterface.

Definition at line 224 of file PageTsBackendLayoutDataProvider.php.

References PageTsBackendLayoutDataProvider\$pageId, PageTsBackendLayoutDataProvider\createBackendLayout(), PageTsBackendLayoutDataProvider\generateBackendLayouts(), and PageTsBackendLayoutDataProvider\setPageId().

getIconPath ( $icon )

protected

Gets and sanitizes the icon path.

Parameters

string $icon Name of the icon file

Returns: string

Definition at line 255 of file PageTsBackendLayoutDataProvider.php.

Referenced by PageTsBackendLayoutDataProvider\createBackendLayout().

getPageId ( )

protected

Get PageId

Returns: int

Definition at line 126 of file PageTsBackendLayoutDataProvider.php.

References PageTsBackendLayoutDataProvider\$pageId.

Referenced by PageTsBackendLayoutDataProvider\generatePageTsConfig().

getPageTsConfig ( )

protected

Get PageTsConfig

Returns: array

Definition at line 105 of file PageTsBackendLayoutDataProvider.php.

References PageTsBackendLayoutDataProvider\$pageTsConfig.

Referenced by PageTsBackendLayoutDataProvider\generateBackendLayouts().

setPageId ( $pageId )

protected

Set PageId

Parameters

int $pageId

Returns: void

Definition at line 116 of file PageTsBackendLayoutDataProvider.php.

References PageTsBackendLayoutDataProvider\$pageId.

Referenced by PageTsBackendLayoutDataProvider\getBackendLayout().

setPageTsConfig ( array $pageTsConfig )

protected

Set PageTsConfig

Parameters

array $pageTsConfig

Returns: void

Definition at line 95 of file PageTsBackendLayoutDataProvider.php.

References PageTsBackendLayoutDataProvider\$pageTsConfig.

Referenced by PageTsBackendLayoutDataProvider\generatePageTsConfig().

Member Data Documentation

$backendLayouts = array()

protected

Definition at line 73 of file PageTsBackendLayoutDataProvider.php.

Referenced by PageTsBackendLayoutDataProvider\generateBackendLayouts().

$pageId = 0

protected

Definition at line 87 of file PageTsBackendLayoutDataProvider.php.

Referenced by PageTsBackendLayoutDataProvider\generatePageTsConfig(), PageTsBackendLayoutDataProvider\getBackendLayout(), PageTsBackendLayoutDataProvider\getPageId(), and PageTsBackendLayoutDataProvider\setPageId().

$pageTsConfig = array()

protected

Definition at line 80 of file PageTsBackendLayoutDataProvider.php.

Referenced by PageTsBackendLayoutDataProvider\generateBackendLayouts(), PageTsBackendLayoutDataProvider\generatePageTsConfig(), PageTsBackendLayoutDataProvider\getPageTsConfig(), and PageTsBackendLayoutDataProvider\setPageTsConfig().