BackendLayoutView Class Reference

TYPO3 7.6

Inheritance diagram for BackendLayoutView:

Public Member Functions
	__construct ()

	setDataProviderCollection (BackendLayout\DataProviderCollection $dataProviderCollection)

	getDataProviderCollection ()

	addBackendLayoutItems (array $parameters)

	getSelectedCombinedIdentifier ($pageId)

	colPosListItemProcFunc (array $parameters)

	getColPosListItemsParsed ($id)

Static Public Member Functions
static	getDefaultColumnLayout ()

Protected Member Functions
	determinePageId ($tableName, array $data)

	getIdentifiersToBeExcluded (array $pageTSconfig)

	addColPosListLayoutItems ($pageId, $items)

	addItems ($items, $iArray)

	getPage ($pageId)

	getRootLine ($pageId)

	createDataProviderContext ()

	getDatabaseConnection ()

	getLanguageService ()

Protected Attributes
	$dataProviderCollection

	$selectedCombinedIdentifier = array()

	$selectedBackendLayout = array()

Detailed Description

Backend layout for CMS

Definition at line 24 of file BackendLayoutView.php.

Constructor & Destructor Documentation

__construct ( )

Creates this object and initializes data providers.

Definition at line 44 of file BackendLayoutView.php.

Member Function Documentation

addBackendLayoutItems ( array $parameters )

Gets backend layout items to be shown in the forms engine. This method is called as "itemsProcFunc" with the accordant context for pages.backend_layout and pages.backend_layout_next_level.

Parameters

array $parameters

Definition at line 99 of file BackendLayoutView.php.

References BackendLayoutView\createDataProviderContext(), BackendLayoutView\determinePageId(), BackendLayoutView\getDataProviderCollection(), BackendLayoutView\getIdentifiersToBeExcluded(), BackendLayoutView\getLanguageService(), and BackendUtility\getPagesTSconfig().

addColPosListLayoutItems	(		$pageId,
			$items
	)

protected

Adds items to a colpos list

Parameters

int	$pageId
array	$items

Returns: array

Definition at line 252 of file BackendLayoutView.php.

Referenced by BackendLayoutView\colPosListItemProcFunc(), and BackendLayoutView\getColPosListItemsParsed().

addItems	(		$items,
			$iArray
	)

protected

Merges items into an item-array, optionally with an icon example: TCEFORM.pages.doktype.addItems.13 = My Label TCEFORM.pages.doktype.addItems.13.icon = EXT:t3skin/icons/gfx/i/pages.gif

Parameters

array	$items	The existing item array
array	$iArray	An array of items to add. NOTICE: The keys are mapped to values, and the values and mapped to be labels. No possibility of adding an icon.

Returns: array The updated $item array

Definition at line 297 of file BackendLayoutView.php.

Referenced by BackendLayoutView\getColPosListItemsParsed().

colPosListItemProcFunc ( array $parameters )

Gets colPos items to be shown in the forms engine. This method is called as "itemsProcFunc" with the accordant context for tt_content.colPos.

Parameters

array $parameters

Returns: void

Definition at line 236 of file BackendLayoutView.php.

References BackendLayoutView\addColPosListLayoutItems(), and BackendLayoutView\determinePageId().

createDataProviderContext ( )

protected

Returns: BackendLayout

Definition at line 449 of file BackendLayoutView.php.

References GeneralUtility\makeInstance().

Referenced by BackendLayoutView\addBackendLayoutItems().

determinePageId	(		$tableName,
		array	$data
	)

protected

Determines the page id for a given record of a database table.

Parameters

string	$tableName
array	$data

Returns: NULL|integer

Definition at line 142 of file BackendLayoutView.php.

References elseif, and BackendLayoutView\getDatabaseConnection().

Referenced by BackendLayoutView\addBackendLayoutItems(), and BackendLayoutView\colPosListItemProcFunc().

getColPosListItemsParsed ( $id )

Gets the list of available columns for a given page id

Parameters

int $id

Returns: array $tcaItems

Definition at line 267 of file BackendLayoutView.php.

References $GLOBALS, BackendLayoutView\addColPosListLayoutItems(), BackendLayoutView\addItems(), BackendUtility\getModTSconfig(), and GeneralUtility\trimExplode().

getDatabaseConnection ( )

protected

Returns

Definition at line 457 of file BackendLayoutView.php.

References $GLOBALS.

Referenced by BackendLayoutView\determinePageId(), and BackendLayoutView\getPage().

getDataProviderCollection ( )

Returns: BackendLayout

Definition at line 87 of file BackendLayoutView.php.

References BackendLayoutView\$dataProviderCollection.

Referenced by BackendLayoutView\addBackendLayoutItems().

static getDefaultColumnLayout ( )

static

Get default columns layout

Returns: string Default four column layout

Definition at line 386 of file BackendLayoutView.php.

Referenced by DefaultDataProvider\createDefaultBackendLayout().

getIdentifiersToBeExcluded ( array $pageTSconfig )

protected

Gets backend layout identifiers to be excluded

Parameters

array $pageTSconfig

Returns: array

Definition at line 213 of file BackendLayoutView.php.

References ArrayUtility\getValueByPath(), ArrayUtility\isValidPath(), and GeneralUtility\trimExplode().

Referenced by BackendLayoutView\addBackendLayoutItems().

getLanguageService ( )

protected

Returns

Definition at line 465 of file BackendLayoutView.php.

References $GLOBALS.

Referenced by BackendLayoutView\addBackendLayoutItems().

getPage ( $pageId )

protected

Gets a page record.

Parameters

int $pageId

Returns: NULL|array

Definition at line 424 of file BackendLayoutView.php.

References BackendLayoutView\getDatabaseConnection(), and BackendUtility\workspaceOL().

Referenced by BackendLayoutView\getSelectedCombinedIdentifier().

getRootLine ( $pageId )

protected

Gets the page root-line.

Parameters

int $pageId

Returns: array

Definition at line 441 of file BackendLayoutView.php.

References BackendUtility\BEgetRootLine().

Referenced by BackendLayoutView\getSelectedCombinedIdentifier().

getSelectedCombinedIdentifier ( $pageId )

Returns the backend layout which should be used for this page.

Parameters

int $pageId

Returns: bool|string Identifier of the backend layout to be used, or FALSE if none

Definition at line 174 of file BackendLayoutView.php.

References elseif, BackendLayoutView\getPage(), and BackendLayoutView\getRootLine().

setDataProviderCollection ( BackendLayout\DataProviderCollection $dataProviderCollection )

Parameters

BackendLayout\DataProviderCollection $dataProviderCollection

Definition at line 79 of file BackendLayoutView.php.

References BackendLayoutView\$dataProviderCollection.

Member Data Documentation

$dataProviderCollection

protected

Definition at line 29 of file BackendLayoutView.php.

Referenced by BackendLayoutView\getDataProviderCollection(), and BackendLayoutView\setDataProviderCollection().

$selectedBackendLayout = array()

protected

Definition at line 39 of file BackendLayoutView.php.

$selectedCombinedIdentifier = array()

protected

Definition at line 34 of file BackendLayoutView.php.