PageTsBackendLayoutDataProvider

class \TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider

Extends
PageTsBackendLayoutDataProvider

This Provider adds Backend Layouts based on page TSconfig

Deprecated

since TYPO3 v12, will be removed in TYPO3 v13

Table of Contents

Properties

$backendLayouts  : array
Internal Backend Layout stack

Methods

addBackendLayouts()  : void
Adds backend layouts to the given backend layout collection.
getBackendLayout()  : BackendLayout|null
Gets a backend layout by (regular) identifier.
attachBackendLayout()  : mixed
Attach Backend Layout to internal Stack
createBackendLayout()  : BackendLayout
Creates a new backend layout using the given record data.
generateBackendLayoutFromTsConfig()  : mixed
Generates a Backend Layout from page TSconfig array
generateBackendLayouts()  : mixed
Generate the Backend Layout configs
getIconPath()  : string
Gets and sanitizes the icon path.
getPageTsConfig()  : array
Gets page TSconfig from DataProviderContext if available from context, else fetch from BackendUtility by pageId.

Properties

$backendLayouts

Internal Backend Layout stack

protected array $backendLayouts = []

Methods

getBackendLayout()

Gets a backend layout by (regular) identifier.

public getBackendLayout(string $identifier, int $pageId) : BackendLayout|null

Parameters

$identifier : string
$pageId : int

Return values

BackendLayout|null

attachBackendLayout()

Attach Backend Layout to internal Stack

protected attachBackendLayout([mixed $backendLayout = null ]) : mixed

Parameters

$backendLayout : mixed = null

createBackendLayout()

Creates a new backend layout using the given record data.

protected createBackendLayout(array $data) : BackendLayout

Parameters

$data : array

Return values

BackendLayout

generateBackendLayoutFromTsConfig()

Generates a Backend Layout from page TSconfig array

protected generateBackendLayoutFromTsConfig(string $identifier, array $data) : mixed

Parameters

$identifier : string
$data : array

generateBackendLayouts()

Generate the Backend Layout configs

protected generateBackendLayouts(DataProviderContext|null $dataProviderContext, int|null $pageId) : mixed

Parameters

$dataProviderContext : DataProviderContext|null
$pageId : int|null

getIconPath()

Gets and sanitizes the icon path.

protected getIconPath(string $icon) : string

Parameters

$icon : string

Name of the icon file

Return values

string

getPageTsConfig()

Gets page TSconfig from DataProviderContext if available from context, else fetch from BackendUtility by pageId.

protected getPageTsConfig(DataProviderContext|null $dataProviderContext, int|null $pageId) : array

Parameters

$dataProviderContext : DataProviderContext|null
$pageId : int|null

Return values

array
On this page