Public Member Functions
	__construct (string $identifier, string $title, string\|array $configuration)

	getIdentifier ()

	setIdentifier (string $identifier)

	getTitle ()

	setTitle (string $title)

	getDescription ()

	setDescription (string $description)

	getIconPath ()

	setIconPath (string $iconPath)

	getConfiguration ()

	setConfiguration (string $configuration)

	getUsedColumns ()

	getColCount ()

	getRowCount ()

	getData ()

	setData (array $data)

	setStructure (array $structure)

	getStructure ()

string[]	getColumnPositionNumbers ()

Static Public Member Functions
static	create (string $identifier, string $title, string\|array $configuration)

Protected Attributes
string	$identifier

string	$title

string	$description = ''

string	$iconPath = ''

string	$configuration = ''

array	$structure = []

array	$data = []

Detailed Description

Class to represent a backend layout.

Definition at line 26 of file BackendLayout.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Backend\View\BackendLayout\BackendLayout::__construct	(	string	$identifier,
		string	$title,
		string\|array	$configuration
	)

Definition at line 50 of file BackendLayout.php.

References TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\$configuration, TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\setConfiguration(), TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\setIdentifier(), and TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\setTitle().

Member Function Documentation

◆ create()

static TYPO3\CMS\Backend\View\BackendLayout\BackendLayout::create	(	string	$identifier,
		string	$title,
		string\|array	$configuration
	)

static

Definition at line 40 of file BackendLayout.php.

References TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\$configuration, TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\$identifier, and TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\$title.

Referenced by TYPO3\CMS\Backend\View\BackendLayout\DefaultDataProvider\createBackendLayout(), TYPO3\CMS\Backend\View\BackendLayout\PageTsBackendLayoutDataProvider\createBackendLayout(), and TYPO3\CMS\Backend\View\BackendLayout\DefaultDataProvider\createDefaultBackendLayout().

◆ getColCount()

TYPO3\CMS\Backend\View\BackendLayout\BackendLayout::getColCount ( )

Definition at line 131 of file BackendLayout.php.

◆ getColumnPositionNumbers()

string [] TYPO3\CMS\Backend\View\BackendLayout\BackendLayout::getColumnPositionNumbers ( )

Returns: ‪string[]

Definition at line 164 of file BackendLayout.php.

Referenced by TYPO3\CMS\Backend\View\Drawing\DrawingConfiguration\create().

◆ getConfiguration()

TYPO3\CMS\Backend\View\BackendLayout\BackendLayout::getConfiguration ( )

Definition at line 109 of file BackendLayout.php.

References TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\$configuration.

Referenced by TYPO3\CMS\Backend\View\BackendLayoutView\parseStructure().

◆ getData()

TYPO3\CMS\Backend\View\BackendLayout\BackendLayout::getData ( )

Definition at line 141 of file BackendLayout.php.

References TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\$data.

◆ getDescription()

TYPO3\CMS\Backend\View\BackendLayout\BackendLayout::getDescription ( )

Definition at line 89 of file BackendLayout.php.

References TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\$description.

◆ getIconPath()

TYPO3\CMS\Backend\View\BackendLayout\BackendLayout::getIconPath ( )

Definition at line 99 of file BackendLayout.php.

References TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\$iconPath.

◆ getIdentifier()

TYPO3\CMS\Backend\View\BackendLayout\BackendLayout::getIdentifier ( )

Definition at line 62 of file BackendLayout.php.

References TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\$identifier.

Referenced by TYPO3\CMS\Backend\View\BackendLayout\BackendLayoutCollection\add().

◆ getRowCount()

TYPO3\CMS\Backend\View\BackendLayout\BackendLayout::getRowCount ( )

Definition at line 136 of file BackendLayout.php.

◆ getStructure()

TYPO3\CMS\Backend\View\BackendLayout\BackendLayout::getStructure ( )

Definition at line 156 of file BackendLayout.php.

References TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\$structure.

◆ getTitle()

TYPO3\CMS\Backend\View\BackendLayout\BackendLayout::getTitle ( )

Definition at line 79 of file BackendLayout.php.

References TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\$title.

◆ getUsedColumns()

TYPO3\CMS\Backend\View\BackendLayout\BackendLayout::getUsedColumns ( )

Returns the columns registered for this layout as $key => $value pair where the key is the colPos and the value is the title. "1" => "Left" etc. Please note that the title can contain LLL references ready for translation.

Definition at line 126 of file BackendLayout.php.