DefaultDataProvider

class \TYPO3\CMS\Backend\View\BackendLayout\DefaultDataProvider

Implements
DataProviderInterface

Backend layout data provider class

Table of Contents

Interfaces

DataProviderInterface
Interface for classes which hook into BackendLayoutDataProvider to provide additional backend layouts from various sources.

Properties

$tableName  : string

Methods

addBackendLayouts()  : mixed
Adds backend layouts to the given backend layout collection.
getBackendLayout()  : BackendLayout|null
Gets a backend layout by (regular) identifier.
createBackendLayout()  : BackendLayout
Creates a new backend layout using the given record data.
createDefaultBackendLayout()  : BackendLayout
Creates a backend layout with the default configuration.
getIconPath()  : string
Resolves the icon from the database record
getLayoutData()  : array
Get all layouts from the core's default data provider.
getPageTSconfigIds()  : array
Returns the page TSconfig from TCEFORM.
getStoragePid()  : int
Returns the storage PID from TCEFORM.

Properties

$tableName

protected string $tableName = 'backend_layout'

Table name for backend_layouts

Methods

getBackendLayout()

Gets a backend layout by (regular) identifier.

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

Parameters

$identifier : string|int
$pageId : int

Return values

BackendLayout|null

createBackendLayout()

Creates a new backend layout using the given record data.

protected createBackendLayout(array $data) : BackendLayout

Parameters

$data : array

Return values

BackendLayout

getIconPath()

Resolves the icon from the database record

protected getIconPath(array $icon) : string

Parameters

$icon : array

Return values

string

getLayoutData()

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

protected getLayoutData(string $fieldName, array $pageTsConfig, int $pageUid) : array

Parameters

$fieldName : string

the name of the field the layouts are provided for (either backend_layout or backend_layout_next_level)

$pageTsConfig : array

PageTSconfig of the given page

$pageUid : int

the ID of the page wea re getting the layouts for

Return values

array —

$layouts A collection of layout data of the registered provider

getPageTSconfigIds()

Returns the page TSconfig from TCEFORM.

protected getPageTSconfigIds(array $pageTsConfig) : array

Parameters

$pageTsConfig : array

Return values

array

getStoragePid()

Returns the storage PID from TCEFORM.

protected getStoragePid(array $pageTsConfig) : int

Parameters

$pageTsConfig : array

Return values

int
On this page