DefaultDataProvider implements DataProviderInterface

Read onlyYes

Backend layout data provider class

Internal

Specific DataProviderInterface implementation, not considered public API.

Table of Contents

Interfaces

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

Methods

__construct()  : mixed
addBackendLayouts()  : void
Adds backend layouts to the given backend layout collection.
getBackendLayout()  : BackendLayout|null
Gets a backend layout by (regular) identifier.
getIdentifier()  : non-empty-string
Returns the unique identifier for this backend layout data provider.
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<string|int, mixed>
Get all layouts from the core's default data provider.
getPageTSconfigIds()  : array<string|int, mixed>
Returns the page TSconfig from TCEFORM.
getStoragePid()  : int
Returns the storage PID from TCEFORM.

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

getIdentifier()

Returns the unique identifier for this backend layout data provider.

public getIdentifier() : non-empty-string

This identifier is used to build combined identifiers in the format "providerIdentifier__layoutIdentifier" (e.g., "my_provider__my_layout").

Requirements:

  • Must be a non-empty string
  • Must not contain double underscores "__" (reserved as separator)
  • Must be unique across all registered backend layout data providers
Return values
non-empty-string —

The unique identifier for this data provider

createBackendLayout()

Creates a new backend layout using the given record data.

protected createBackendLayout(array<string|int, mixed> $data) : BackendLayout
Parameters
$data : array<string|int, mixed>
Return values
BackendLayout

getIconPath()

Resolves the icon from the database record

protected getIconPath(array<string|int, mixed> $icon) : string
Parameters
$icon : array<string|int, mixed>
Return values
string

getLayoutData()

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

protected getLayoutData(string $fieldName, array<string|int, mixed> $pageTsConfig, int $pageUid) : array<string|int, mixed>
Parameters
$fieldName : string

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

$pageTsConfig : array<string|int, mixed>

PageTSconfig of the given page

$pageUid : int

the ID of the page wea re getting the layouts for

Return values
array<string|int, mixed> —

$layouts A collection of layout data of the registered provider

getPageTSconfigIds()

Returns the page TSconfig from TCEFORM.

protected getPageTSconfigIds(array<string|int, mixed> $pageTsConfig) : array<string|int, mixed>
Parameters
$pageTsConfig : array<string|int, mixed>
Return values
array<string|int, mixed>

getStoragePid()

Returns the storage PID from TCEFORM.

protected getStoragePid(array<string|int, mixed> $pageTsConfig) : int
Parameters
$pageTsConfig : array<string|int, mixed>
Return values
int 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results