‪TYPO3CMS  10.4
Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Backend\View\BackendLayout\BackendLayout Class Reference

Public Member Functions

 __construct ($identifier, $title, $configuration)
 
string getIdentifier ()
 
 setIdentifier ($identifier)
 
string getTitle ()
 
 setTitle ($title)
 
string getDescription ()
 
 setDescription ($description)
 
string getIconPath ()
 
 setIconPath ($iconPath)
 
string getConfiguration ()
 
 setConfiguration ($configuration)
 
array getUsedColumns ()
 
array getData ()
 
 setData (array $data)
 
 setStructure (array $structure)
 
 getStructure ()
 
 getColumnPositionNumbers ()
 

Static Public Member Functions

static BackendLayout create ($identifier, $title, $configuration)
 

Protected Attributes

string $identifier
 
string $title
 
string $description
 
string $iconPath
 
string $configuration
 
array $structure = array( )
 
array $data
 

Detailed Description

Class to represent a backend layout.

Definition at line 24 of file BackendLayout.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 77 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 BackendLayout TYPO3\CMS\Backend\View\BackendLayout\BackendLayout::create (   $identifier,
  $title,
  $configuration 
)
static
Parameters
string$identifier
string$title
string | array$configuration
Returns
‪BackendLayout

Definition at line 62 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\Provider\PageTsBackendLayoutDataProvider\createBackendLayout(), and TYPO3\CMS\Backend\View\BackendLayout\DefaultDataProvider\createDefaultBackendLayout().

◆ getColumnPositionNumbers()

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

Definition at line 216 of file BackendLayout.php.

◆ getConfiguration()

string TYPO3\CMS\Backend\View\BackendLayout\BackendLayout::getConfiguration ( )
Returns
‪string

Definition at line 164 of file BackendLayout.php.

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

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

◆ getData()

array TYPO3\CMS\Backend\View\BackendLayout\BackendLayout::getData ( )
Returns
‪array

Definition at line 193 of file BackendLayout.php.

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

◆ getDescription()

string TYPO3\CMS\Backend\View\BackendLayout\BackendLayout::getDescription ( )
Returns
‪string

Definition at line 132 of file BackendLayout.php.

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

◆ getIconPath()

string TYPO3\CMS\Backend\View\BackendLayout\BackendLayout::getIconPath ( )
Returns
‪string

Definition at line 148 of file BackendLayout.php.

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

◆ getIdentifier()

string TYPO3\CMS\Backend\View\BackendLayout\BackendLayout::getIdentifier ( )
Returns
‪string

Definition at line 92 of file BackendLayout.php.

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

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

◆ getStructure()

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

Definition at line 211 of file BackendLayout.php.

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

◆ getTitle()

string TYPO3\CMS\Backend\View\BackendLayout\BackendLayout::getTitle ( )
Returns
‪string

Definition at line 116 of file BackendLayout.php.

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

◆ getUsedColumns()

array 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.

Returns
‪array

Definition at line 185 of file BackendLayout.php.

◆ setConfiguration()

TYPO3\CMS\Backend\View\BackendLayout\BackendLayout::setConfiguration (   $configuration)
Parameters
string$configuration

Definition at line 172 of file BackendLayout.php.

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

Referenced by TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\__construct().

◆ setData()

TYPO3\CMS\Backend\View\BackendLayout\BackendLayout::setData ( array  $data)
Parameters
array$data

Definition at line 201 of file BackendLayout.php.

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

◆ setDescription()

TYPO3\CMS\Backend\View\BackendLayout\BackendLayout::setDescription (   $description)
Parameters
string$description

Definition at line 140 of file BackendLayout.php.

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

◆ setIconPath()

TYPO3\CMS\Backend\View\BackendLayout\BackendLayout::setIconPath (   $iconPath)
Parameters
string$iconPath

Definition at line 156 of file BackendLayout.php.

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

◆ setIdentifier()

TYPO3\CMS\Backend\View\BackendLayout\BackendLayout::setIdentifier (   $identifier)
Parameters
string$identifier
Exceptions

Definition at line 101 of file BackendLayout.php.

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

Referenced by TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\__construct().

◆ setStructure()

TYPO3\CMS\Backend\View\BackendLayout\BackendLayout::setStructure ( array  $structure)

Definition at line 206 of file BackendLayout.php.

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

◆ setTitle()

TYPO3\CMS\Backend\View\BackendLayout\BackendLayout::setTitle (   $title)
Parameters
string$title

Definition at line 124 of file BackendLayout.php.

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

Referenced by TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\__construct().

Member Data Documentation

◆ $configuration

string TYPO3\CMS\Backend\View\BackendLayout\BackendLayout::$configuration
protected

Definition at line 44 of file BackendLayout.php.

Referenced by TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\__construct(), TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\create(), TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\getConfiguration(), and TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\setConfiguration().

◆ $data

array TYPO3\CMS\Backend\View\BackendLayout\BackendLayout::$data
protected

Definition at line 54 of file BackendLayout.php.

Referenced by TYPO3\CMS\Backend\View\BackendLayout\DefaultDataProvider\addBackendLayouts(), TYPO3\CMS\Backend\View\BackendLayout\DefaultDataProvider\createBackendLayout(), TYPO3\CMS\Backend\View\BackendLayout\DefaultDataProvider\getBackendLayout(), TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\getData(), and TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\setData().

◆ $description

string TYPO3\CMS\Backend\View\BackendLayout\BackendLayout::$description
protected

Definition at line 36 of file BackendLayout.php.

Referenced by TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\getDescription(), and TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\setDescription().

◆ $iconPath

string TYPO3\CMS\Backend\View\BackendLayout\BackendLayout::$iconPath
protected

Definition at line 40 of file BackendLayout.php.

Referenced by TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\getIconPath(), and TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\setIconPath().

◆ $identifier

string TYPO3\CMS\Backend\View\BackendLayout\BackendLayout::$identifier
protected

Definition at line 28 of file BackendLayout.php.

Referenced by TYPO3\CMS\Backend\View\BackendLayout\DataProviderCollection\add(), TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\create(), TYPO3\CMS\Backend\View\BackendLayout\DataProviderCollection\createBackendLayoutCollection(), TYPO3\CMS\Backend\View\BackendLayout\DefaultDataProvider\getBackendLayout(), TYPO3\CMS\Backend\View\BackendLayout\DataProviderCollection\getBackendLayoutCollections(), TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\getIdentifier(), and TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\setIdentifier().

◆ $structure

array TYPO3\CMS\Backend\View\BackendLayout\BackendLayout::$structure = array( )
protected

The structured data of the configuration represented as array.

Definition at line 50 of file BackendLayout.php.

Referenced by TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\getStructure(), and TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\setStructure().

◆ $title

string TYPO3\CMS\Backend\View\BackendLayout\BackendLayout::$title
protected

Definition at line 32 of file BackendLayout.php.

Referenced by TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\create(), TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\getTitle(), TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumn\getTitle(), TYPO3\CMS\Backend\View\BackendLayout\Grid\GridColumnItem\renderLanguageFlag(), and TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\setTitle().