‪TYPO3CMS  10.4
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Backend\View\BackendLayoutView Class Reference
Inheritance diagram for TYPO3\CMS\Backend\View\BackendLayoutView:
TYPO3\CMS\Core\SingletonInterface

Public Member Functions

 __construct ()
 
 setDataProviderCollection (DataProviderCollection $dataProviderCollection)
 
DataProviderCollection getDataProviderCollection ()
 
 addBackendLayoutItems (array $parameters)
 
bool string getSelectedCombinedIdentifier ($pageId)
 
 colPosListItemProcFunc (array $parameters)
 
array getColPosListItemsParsed ($id)
 
array null getSelectedBackendLayout ($pageId)
 
BackendLayout getBackendLayoutForPage (int $pageId)
 
array parseStructure (BackendLayout $backendLayout)
 

Static Public Member Functions

static string getDefaultColumnLayout ()
 

Protected Member Functions

 initializeDataProviderCollection ()
 
int false determinePageId ($tableName, array $data)
 
array getIdentifiersToBeExcluded (array $pageTSconfig)
 
array addColPosListLayoutItems ($pageId, $items)
 
array addItems ($items, $iArray)
 
array null getPage ($pageId)
 
array getRootLine ($pageId)
 
DataProviderContext createDataProviderContext ()
 
LanguageService getLanguageService ()
 
string getColumnName ($column)
 

Protected Attributes

DataProviderCollection $dataProviderCollection
 
array $selectedCombinedIdentifier = array( )
 
array $selectedBackendLayout = array( )
 

Detailed Description

Backend layout for CMS

This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.

Definition at line 35 of file BackendLayoutView.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Backend\View\BackendLayoutView::__construct ( )

Creates this object and initializes data providers.

Definition at line 52 of file BackendLayoutView.php.

References TYPO3\CMS\Backend\View\BackendLayoutView\initializeDataProviderCollection().

Member Function Documentation

◆ addBackendLayoutItems()

TYPO3\CMS\Backend\View\BackendLayoutView::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 98 of file BackendLayoutView.php.

References TYPO3\CMS\Backend\View\BackendLayoutView\createDataProviderContext(), TYPO3\CMS\Backend\View\BackendLayoutView\determinePageId(), TYPO3\CMS\Backend\View\BackendLayout\DataProviderCollection\getBackendLayoutCollections(), TYPO3\CMS\Backend\View\BackendLayoutView\getDataProviderCollection(), TYPO3\CMS\Backend\View\BackendLayout\BackendLayoutCollection\getIdentifier(), TYPO3\CMS\Backend\View\BackendLayoutView\getIdentifiersToBeExcluded(), TYPO3\CMS\Backend\View\BackendLayoutView\getLanguageService(), TYPO3\CMS\Backend\Utility\BackendUtility\getPagesTSconfig(), TYPO3\CMS\Backend\View\BackendLayout\DataProviderContext\setData(), TYPO3\CMS\Backend\View\BackendLayout\DataProviderContext\setFieldName(), TYPO3\CMS\Backend\View\BackendLayout\DataProviderContext\setPageId(), TYPO3\CMS\Backend\View\BackendLayout\DataProviderContext\setPageTsConfig(), TYPO3\CMS\Backend\View\BackendLayout\DataProviderContext\setTableName(), and TYPO3\CMS\Core\Localization\LanguageService\sL().

◆ addColPosListLayoutItems()

array TYPO3\CMS\Backend\View\BackendLayoutView::addColPosListLayoutItems (   $pageId,
  $items 
)
protected

Adds items to a colpos list

Parameters
int$pageId
array$items
Returns
‪array

Definition at line 259 of file BackendLayoutView.php.

References TYPO3\CMS\Backend\View\BackendLayoutView\getSelectedBackendLayout().

Referenced by TYPO3\CMS\Backend\View\BackendLayoutView\colPosListItemProcFunc(), and TYPO3\CMS\Backend\View\BackendLayoutView\getColPosListItemsParsed().

◆ addItems()

array TYPO3\CMS\Backend\View\BackendLayoutView::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 306 of file BackendLayoutView.php.

Referenced by TYPO3\CMS\Backend\View\BackendLayoutView\getColPosListItemsParsed().

◆ colPosListItemProcFunc()

TYPO3\CMS\Backend\View\BackendLayoutView::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

Definition at line 243 of file BackendLayoutView.php.

References TYPO3\CMS\Backend\View\BackendLayoutView\addColPosListLayoutItems(), and TYPO3\CMS\Backend\View\BackendLayoutView\determinePageId().

◆ createDataProviderContext()

DataProviderContext TYPO3\CMS\Backend\View\BackendLayoutView::createDataProviderContext ( )
protected
Returns
‪DataProviderContext

Definition at line 478 of file BackendLayoutView.php.

Referenced by TYPO3\CMS\Backend\View\BackendLayoutView\addBackendLayoutItems().

◆ determinePageId()

int false TYPO3\CMS\Backend\View\BackendLayoutView::determinePageId (   $tableName,
array  $data 
)
protected

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

Parameters
string$tableName
array$data
Returns
‪int|false Returns page id or false on error

Definition at line 141 of file BackendLayoutView.php.

Referenced by TYPO3\CMS\Backend\View\BackendLayoutView\addBackendLayoutItems(), and TYPO3\CMS\Backend\View\BackendLayoutView\colPosListItemProcFunc().

◆ getBackendLayoutForPage()

BackendLayout TYPO3\CMS\Backend\View\BackendLayoutView::getBackendLayoutForPage ( int  $pageId)

Get the BackendLayout object and parse the structure based on the UserTSconfig

Parameters
int$pageId
Returns
‪BackendLayout

Definition at line 348 of file BackendLayoutView.php.

References TYPO3\CMS\Backend\View\BackendLayoutView\$selectedCombinedIdentifier, TYPO3\CMS\Backend\View\BackendLayout\DataProviderCollection\getBackendLayout(), TYPO3\CMS\Backend\View\BackendLayoutView\getDataProviderCollection(), and TYPO3\CMS\Backend\View\BackendLayoutView\getSelectedCombinedIdentifier().

Referenced by TYPO3\CMS\Backend\View\BackendLayoutView\getSelectedBackendLayout().

◆ getColPosListItemsParsed()

array TYPO3\CMS\Backend\View\BackendLayoutView::getColPosListItemsParsed (   $id)

Gets the list of available columns for a given page id

Parameters
int$id
Returns
‪array $tcaItems

Definition at line 274 of file BackendLayoutView.php.

References $GLOBALS, TYPO3\CMS\Backend\View\BackendLayoutView\addColPosListLayoutItems(), TYPO3\CMS\Backend\View\BackendLayoutView\addItems(), TYPO3\CMS\Backend\Utility\BackendUtility\getPagesTSconfig(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

◆ getColumnName()

string TYPO3\CMS\Backend\View\BackendLayoutView::getColumnName (   $column)
protected

Get column name from colPos item structure

Parameters
array$column
Returns
‪string

Definition at line 497 of file BackendLayoutView.php.

References TYPO3\CMS\Backend\View\BackendLayoutView\getLanguageService(), and TYPO3\CMS\Core\Localization\LanguageService\sL().

Referenced by TYPO3\CMS\Backend\View\BackendLayoutView\parseStructure().

◆ getDataProviderCollection()

DataProviderCollection TYPO3\CMS\Backend\View\BackendLayoutView::getDataProviderCollection ( )
Returns
‪DataProviderCollection

Definition at line 86 of file BackendLayoutView.php.

References TYPO3\CMS\Backend\View\BackendLayoutView\$dataProviderCollection.

Referenced by TYPO3\CMS\Backend\View\BackendLayoutView\addBackendLayoutItems(), and TYPO3\CMS\Backend\View\BackendLayoutView\getBackendLayoutForPage().

◆ getDefaultColumnLayout()

static string TYPO3\CMS\Backend\View\BackendLayoutView::getDefaultColumnLayout ( )
static

Get default columns layout

Returns
‪string Default four column layout

Definition at line 416 of file BackendLayoutView.php.

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

◆ getIdentifiersToBeExcluded()

array TYPO3\CMS\Backend\View\BackendLayoutView::getIdentifiersToBeExcluded ( array  $pageTSconfig)
protected

Gets backend layout identifiers to be excluded

Parameters
array$pageTSconfig
Returns
‪array

Definition at line 221 of file BackendLayoutView.php.

References TYPO3\CMS\Core\Utility\ArrayUtility\getValueByPath(), TYPO3\CMS\Core\Utility\ArrayUtility\isValidPath(), and TYPO3\CMS\Core\Utility\GeneralUtility\trimExplode().

Referenced by TYPO3\CMS\Backend\View\BackendLayoutView\addBackendLayoutItems().

◆ getLanguageService()

LanguageService TYPO3\CMS\Backend\View\BackendLayoutView::getLanguageService ( )
protected
Returns
‪LanguageService

Definition at line 486 of file BackendLayoutView.php.

References $GLOBALS.

Referenced by TYPO3\CMS\Backend\View\BackendLayoutView\addBackendLayoutItems(), and TYPO3\CMS\Backend\View\BackendLayoutView\getColumnName().

◆ getPage()

array null TYPO3\CMS\Backend\View\BackendLayoutView::getPage (   $pageId)
protected

Gets a page record.

Parameters
int$pageId
Returns
‪array|null

Definition at line 442 of file BackendLayoutView.php.

References TYPO3\CMS\Backend\Utility\BackendUtility\workspaceOL().

Referenced by TYPO3\CMS\Backend\View\BackendLayoutView\getSelectedCombinedIdentifier().

◆ getRootLine()

array TYPO3\CMS\Backend\View\BackendLayoutView::getRootLine (   $pageId)
protected

Gets the page root-line.

Parameters
int$pageId
Returns
‪array

Definition at line 470 of file BackendLayoutView.php.

References TYPO3\CMS\Backend\Utility\BackendUtility\BEgetRootLine().

Referenced by TYPO3\CMS\Backend\View\BackendLayoutView\getSelectedCombinedIdentifier().

◆ getSelectedBackendLayout()

array null TYPO3\CMS\Backend\View\BackendLayoutView::getSelectedBackendLayout (   $pageId)

Gets the selected backend layout structure as an array

Parameters
int$pageId
Returns
‪array|null $backendLayout

Definition at line 334 of file BackendLayoutView.php.

References TYPO3\CMS\Backend\View\BackendLayoutView\getBackendLayoutForPage().

Referenced by TYPO3\CMS\Backend\View\BackendLayoutView\addColPosListLayoutItems(), and TYPO3\CMS\Backend\View\PageLayoutView\getTable_tt_content().

◆ getSelectedCombinedIdentifier()

bool string TYPO3\CMS\Backend\View\BackendLayoutView::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 181 of file BackendLayoutView.php.

References TYPO3\CMS\Backend\View\BackendLayoutView\getPage(), and TYPO3\CMS\Backend\View\BackendLayoutView\getRootLine().

Referenced by TYPO3\CMS\Backend\View\BackendLayoutView\getBackendLayoutForPage().

◆ initializeDataProviderCollection()

TYPO3\CMS\Backend\View\BackendLayoutView::initializeDataProviderCollection ( )
protected

Initializes data providers

Definition at line 60 of file BackendLayoutView.php.

References TYPO3\CMS\Backend\View\BackendLayoutView\$dataProviderCollection, $GLOBALS, TYPO3\CMS\Backend\View\BackendLayout\DataProviderCollection\add(), and TYPO3\CMS\Backend\View\BackendLayoutView\setDataProviderCollection().

Referenced by TYPO3\CMS\Backend\View\BackendLayoutView\__construct().

◆ parseStructure()

array TYPO3\CMS\Backend\View\BackendLayoutView::parseStructure ( BackendLayout  $backendLayout)
Parameters
BackendLayout$backendLayout
Returns
‪array

Definition at line 375 of file BackendLayoutView.php.

References $parser, TYPO3\CMS\Core\TypoScript\Parser\TypoScriptParser\checkIncludeLines(), TYPO3\CMS\Backend\View\BackendLayoutView\getColumnName(), and TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\getConfiguration().

◆ setDataProviderCollection()

TYPO3\CMS\Backend\View\BackendLayoutView::setDataProviderCollection ( DataProviderCollection  $dataProviderCollection)
Parameters
DataProviderCollection$dataProviderCollection

Definition at line 78 of file BackendLayoutView.php.

References TYPO3\CMS\Backend\View\BackendLayoutView\$dataProviderCollection.

Referenced by TYPO3\CMS\Backend\View\BackendLayoutView\initializeDataProviderCollection().

Member Data Documentation

◆ $dataProviderCollection

DataProviderCollection TYPO3\CMS\Backend\View\BackendLayoutView::$dataProviderCollection
protected

Definition at line 39 of file BackendLayoutView.php.

Referenced by TYPO3\CMS\Backend\View\BackendLayoutView\getDataProviderCollection(), TYPO3\CMS\Backend\View\BackendLayoutView\initializeDataProviderCollection(), and TYPO3\CMS\Backend\View\BackendLayoutView\setDataProviderCollection().

◆ $selectedBackendLayout

array TYPO3\CMS\Backend\View\BackendLayoutView::$selectedBackendLayout = array( )
protected

Definition at line 47 of file BackendLayoutView.php.

◆ $selectedCombinedIdentifier

array TYPO3\CMS\Backend\View\BackendLayoutView::$selectedCombinedIdentifier = array( )
protected

Definition at line 43 of file BackendLayoutView.php.

Referenced by TYPO3\CMS\Backend\View\BackendLayoutView\getBackendLayoutForPage().