BackendLayoutView
class \
- Implements
- SingletonInterface
Backend layout for CMS
Internal
This class is a TYPO3 Backend implementation and is not considered part of the Public TYPO3 API.
Table of Contents
Interfaces
- SingletonInterface
- "empty" interface for singletons (marker interface pattern)
Properties
- $selectedBackendLayout : array
- $selectedCombinedIdentifier : array
Methods
- __construct() : mixed
- Create this object and initialize data providers.
- addBackendLayoutItems() : mixed
- Gets backend layout items to be shown in the forms engine.
- colPosListItemProcFunc() : void
- Gets colPos items to be shown in the forms engine.
- getBackendLayoutForPage() : BackendLayout|null
- Get the BackendLayout object and parse the structure based on the UserTSconfig
- getSelectedBackendLayout() : array|null
- Gets the selected backend layout structure as an array
- getSelectedCombinedIdentifier() : false|string
- Returns the backend layout which should be used for this page.
- parseStructure() : array
- addColPosListLayoutItems() : array
- Adds items to a colpos list
- determinePageId() : int|false
- Determines the page id for a given record of a database table.
- getIdentifiersToBeExcluded() : array
- Gets backend layout identifiers to be excluded
Properties
$selectedBackendLayout
protected
array
$selectedBackendLayout
= []
$selectedCombinedIdentifier
protected
array
$selectedCombinedIdentifier
= []
Methods
__construct()
Create this object and initialize data providers.
public
__construct(DataProviderCollection $dataProviderCollection, TypoScriptStringFactory $typoScriptStringFactory, PageLayoutResolver $pageLayoutResolver) : mixed
Parameters
- $dataProviderCollection : DataProviderCollection
- $typoScriptStringFactory : TypoScriptStringFactory
- $pageLayoutResolver : PageLayoutResolver
addBackendLayoutItems()
Gets backend layout items to be shown in the forms engine.
public
addBackendLayoutItems(array &$parameters) : mixed
This method is called as "itemsProcFunc" with the accordant context for pages.backend_layout and pages.backend_layout_next_level. Also used in the info module, since we need those items with the appropriate labels and backend layout identifiers there, too.
Parameters
- $parameters : array
Tags
colPosListItemProcFunc()
Gets colPos items to be shown in the forms engine.
public
colPosListItemProcFunc(array &$parameters) : void
This method is called as "itemsProcFunc" with the accordant context for tt_content.colPos.
Parameters
- $parameters : array
getBackendLayoutForPage()
Get the BackendLayout object and parse the structure based on the UserTSconfig
public
getBackendLayoutForPage(int $pageId) : BackendLayout|null
Parameters
- $pageId : int
Return values
BackendLayout|nullgetSelectedBackendLayout()
Gets the selected backend layout structure as an array
public
getSelectedBackendLayout(int $pageId) : array|null
Parameters
- $pageId : int
Return values
array|nullgetSelectedCombinedIdentifier()
Returns the backend layout which should be used for this page.
public
getSelectedCombinedIdentifier(int $pageId) : false|string
Parameters
- $pageId : int
Internal
only public for testing purposes
Return values
false|string —Identifier of the backend layout to be used, or FALSE if none
parseStructure()
public
parseStructure(BackendLayout $backendLayout) : array
Parameters
- $backendLayout : BackendLayout
Internal
Return values
arrayaddColPosListLayoutItems()
Adds items to a colpos list
protected
addColPosListLayoutItems(int $pageId, array $items) : array
Parameters
- $pageId : int
- $items : array
Return values
arraydeterminePageId()
Determines the page id for a given record of a database table.
protected
determinePageId(string $tableName, array $data) : int|false
Parameters
- $tableName : string
- $data : array
Return values
int|false —Returns page id or false on error
getIdentifiersToBeExcluded()
Gets backend layout identifiers to be excluded
protected
getIdentifiersToBeExcluded(array $pageTSconfig) : array
Parameters
- $pageTSconfig : array