TYPO3\CMS\Backend\View\BackendLayout\DefaultDataProvider Class Reference

Inheritance diagram for TYPO3\CMS\Backend\View\BackendLayout\DefaultDataProvider:

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

Protected Member Functions
BackendLayout	createDefaultBackendLayout ()
BackendLayout	createBackendLayout (array $data)
string	getIconPath (array $icon)
array	getLayoutData ($fieldName, array $pageTsConfig, $pageUid)
int	getStoragePid (array $pageTsConfig)
array	getPageTSconfigIds (array $pageTsConfig)

Protected Attributes
string	$tableName = 'backend_layout'

Detailed Description

Backend layout data provider class

Definition at line 30 of file DefaultDataProvider.php.

Member Function Documentation

addBackendLayouts()

TYPO3\CMS\Backend\View\BackendLayout\DefaultDataProvider::addBackendLayouts	(	DataProviderContext	$dataProviderContext,
		BackendLayoutCollection	$backendLayoutCollection
	)

Adds backend layouts to the given backend layout collection. The default backend layout ('default_default') is not added since it's the default fallback if nothing is specified.

Parameters

DataProviderContext	$dataProviderContext
BackendLayoutCollection	$backendLayoutCollection

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

Definition at line 46 of file DefaultDataProvider.php.

References TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\$data, TYPO3\CMS\Backend\View\BackendLayout\BackendLayoutCollection\add(), TYPO3\CMS\Backend\View\BackendLayout\DefaultDataProvider\createBackendLayout(), TYPO3\CMS\Backend\View\BackendLayout\DataProviderContext\getFieldName(), TYPO3\CMS\Backend\View\BackendLayout\DefaultDataProvider\getLayoutData(), TYPO3\CMS\Backend\View\BackendLayout\DataProviderContext\getPageId(), and TYPO3\CMS\Backend\View\BackendLayout\DataProviderContext\getPageTsConfig().

createBackendLayout()

BackendLayout TYPO3\CMS\Backend\View\BackendLayout\DefaultDataProvider::createBackendLayout ( array  $data )

protected

Creates a new backend layout using the given record data.

Parameters

array

$data

Returns

‪BackendLayout

Definition at line 106 of file DefaultDataProvider.php.

References TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\$data, TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\create(), and TYPO3\CMS\Backend\View\BackendLayout\DefaultDataProvider\getIconPath().

Referenced by TYPO3\CMS\Backend\View\BackendLayout\DefaultDataProvider\addBackendLayouts(), and TYPO3\CMS\Backend\View\BackendLayout\DefaultDataProvider\getBackendLayout().

createDefaultBackendLayout()

BackendLayout TYPO3\CMS\Backend\View\BackendLayout\DefaultDataProvider::createDefaultBackendLayout ( )

protected

Creates a backend layout with the default configuration.

Returns

‪BackendLayout

Definition at line 91 of file DefaultDataProvider.php.

References TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\create(), and TYPO3\CMS\Backend\View\BackendLayoutView\getDefaultColumnLayout().

Referenced by TYPO3\CMS\Backend\View\BackendLayout\DefaultDataProvider\getBackendLayout().

getBackendLayout()

BackendLayout null TYPO3\CMS\Backend\View\BackendLayout\DefaultDataProvider::getBackendLayout	(		$identifier,
			$pageId
	)

Gets a backend layout by (regular) identifier.

Parameters

string | int	$identifier
int	$pageId

Returns

‪BackendLayout|null

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

Definition at line 69 of file DefaultDataProvider.php.

References TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\$data, TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\$identifier, TYPO3\CMS\Backend\View\BackendLayout\DefaultDataProvider\createBackendLayout(), TYPO3\CMS\Backend\View\BackendLayout\DefaultDataProvider\createDefaultBackendLayout(), and TYPO3\CMS\Backend\Utility\BackendUtility\getRecordWSOL().

getIconPath()

string TYPO3\CMS\Backend\View\BackendLayout\DefaultDataProvider::getIconPath ( array  $icon )

protected

Resolves the icon from the database record

Parameters

array

$icon

Returns

‪string

Definition at line 120 of file DefaultDataProvider.php.

Referenced by TYPO3\CMS\Backend\View\BackendLayout\DefaultDataProvider\createBackendLayout().

getLayoutData()

array TYPO3\CMS\Backend\View\BackendLayout\DefaultDataProvider::getLayoutData (   $fieldName, array  $pageTsConfig,   $pageUid  )

protected

Get all layouts from the core's default data provider.

Parameters

string	$fieldName	‪the name of the field the layouts are provided for (either backend_layout or backend_layout_next_level)
array	$pageTsConfig	‪PageTSconfig of the given page
int	$pageUid	‪the ID of the page wea re getting the layouts for

Returns

‪array $layouts A collection of layout data of the registered provider

Definition at line 139 of file DefaultDataProvider.php.

References $GLOBALS, TYPO3\CMS\Core\Database\Query\Expression\ExpressionBuilder\EQ, TYPO3\CMS\Backend\View\BackendLayout\DefaultDataProvider\getPageTSconfigIds(), TYPO3\CMS\Backend\View\BackendLayout\DefaultDataProvider\getStoragePid(), and TYPO3\CMS\Backend\Utility\BackendUtility\workspaceOL().

Referenced by TYPO3\CMS\Backend\View\BackendLayout\DefaultDataProvider\addBackendLayouts().

getPageTSconfigIds()

array TYPO3\CMS\Backend\View\BackendLayout\DefaultDataProvider::getPageTSconfigIds ( array  $pageTsConfig )

protected

Returns the page TSconfig from TCEFORM.

Parameters

array

$pageTsConfig

Returns

‪array

Definition at line 235 of file DefaultDataProvider.php.

Referenced by TYPO3\CMS\Backend\View\BackendLayout\DefaultDataProvider\getLayoutData().

getStoragePid()

int TYPO3\CMS\Backend\View\BackendLayout\DefaultDataProvider::getStoragePid ( array  $pageTsConfig )

protected

Returns the storage PID from TCEFORM.

Parameters

array

$pageTsConfig

Returns

‪int

Definition at line 218 of file DefaultDataProvider.php.

Referenced by TYPO3\CMS\Backend\View\BackendLayout\DefaultDataProvider\getLayoutData().

Member Data Documentation

$tableName

string TYPO3\CMS\Backend\View\BackendLayout\DefaultDataProvider::$tableName = 'backend_layout'

protected

Table name for backend_layouts

Definition at line 36 of file DefaultDataProvider.php.