BackendLayout

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

Class to represent a backend layout.

Table of Contents

Properties

$configuration  : string
$data  : array
$description  : string
$iconPath  : string
$identifier  : string
$structure  : array
The structured data of the configuration represented as array.
$title  : string

Methods

__construct()  : mixed
create()  : BackendLayout
getColCount()  : int
getColumnPositionNumbers()  : string[]
getConfiguration()  : string
getData()  : array
getDescription()  : string
getIconPath()  : string
getIdentifier()  : string
getIdentifierCleaned()  : string
getRowCount()  : int
getStructure()  : array
getTitle()  : string
getUsedColumns()  : array
Returns the columns registered for this layout as $key => $value pair where the key is the colPos and the value is the title.
setConfiguration()  : void
setData()  : void
setDescription()  : void
setIconPath()  : void
setIdentifier()  : void
setStructure()  : void
setTitle()  : void

Properties

$configuration

protected string $configuration = ''

$description

protected string $description = ''

$structure

The structured data of the configuration represented as array.

protected array $structure = []

Methods

__construct()

public __construct(string $identifier, string $title, string|array $configuration) : mixed

Parameters

$identifier : string
$title : string
$configuration : string|array

create()

public static create(string $identifier, string $title, string|array $configuration) : BackendLayout

Parameters

$identifier : string
$title : string
$configuration : string|array

Return values

BackendLayout

getColCount()

public getColCount() : int

Return values

int

getColumnPositionNumbers()

public getColumnPositionNumbers() : string[]

Return values

string[]

getConfiguration()

public getConfiguration() : string

Return values

string

getData()

public getData() : array

Return values

array

getDescription()

public getDescription() : string

Return values

string

getIconPath()

public getIconPath() : string

Return values

string

getIdentifier()

public getIdentifier() : string

Return values

string

getIdentifierCleaned()

public getIdentifierCleaned() : string

Return values

string

getRowCount()

public getRowCount() : int

Return values

int

getStructure()

public getStructure() : array

Return values

array

getTitle()

public getTitle() : string

Return values

string

getUsedColumns()

Returns the columns registered for this layout as $key => $value pair where the key is the colPos and the value is the title.

public getUsedColumns() : array

"1" => "Left" etc. Please note that the title can contain LLL references ready for translation.

Return values

array

setConfiguration()

public setConfiguration(string $configuration) : void

Parameters

$configuration : string

setData()

public setData(array $data) : void

Parameters

$data : array

setDescription()

public setDescription(string $description) : void

Parameters

$description : string

setIconPath()

public setIconPath(string $iconPath) : void

Parameters

$iconPath : string

setIdentifier()

public setIdentifier(string $identifier) : void

Parameters

$identifier : string

setStructure()

public setStructure(array $structure) : void

Parameters

$structure : array

setTitle()

public setTitle(string $title) : void

Parameters

$title : string
On this page