TYPO3 CMS  TYPO3_6-2
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)
 
 getIdentifier ()
 
 setIdentifier ($identifier)
 
 getTitle ()
 
 setTitle ($title)
 
 getDescription ()
 
 setDescription ($description)
 
 getIconPath ()
 
 setIconPath ($iconPath)
 
 getConfiguration ()
 
 setConfiguration ($configuration)
 
 getData ()
 
 setData (array $data)
 

Static Public Member Functions

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

Protected Attributes

 $identifier
 
 $title
 
 $description
 
 $iconPath
 
 $configuration
 
 $data
 

Detailed Description

This file is part of the TYPO3 CMS project.

It is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, either version 2 of the License, or any later version.

For the full copyright and license information, please read the LICENSE.txt file that was distributed with this source code.

The TYPO3 project - inspiring people to share! Class to represent a backend layout.

Author
Oliver Hader olive.nosp@m.r.ha.nosp@m.der@t.nosp@m.ypo3.nosp@m..org

Definition at line 22 of file BackendLayout.php.

Constructor & Destructor Documentation

◆ __construct()

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

Definition at line 74 of file BackendLayout.php.

References TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\$configuration, TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\$identifier, TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\$title, 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 (   $identifier,
  $title,
  $configuration 
)
static
Parameters
string$identifier
string$title
string$configuration
Returns
BackendLayout

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

◆ getConfiguration()

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

Definition at line 147 of file BackendLayout.php.

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

◆ getData()

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

Definition at line 161 of file BackendLayout.php.

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

◆ getDescription()

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

Definition at line 119 of file BackendLayout.php.

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

◆ getIconPath()

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

Definition at line 133 of file BackendLayout.php.

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

◆ getIdentifier()

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

Definition at line 83 of file BackendLayout.php.

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

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

◆ getTitle()

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

Definition at line 105 of file BackendLayout.php.

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

◆ setConfiguration()

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

Definition at line 154 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 168 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 126 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 140 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 91 of file BackendLayout.php.

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

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

◆ setTitle()

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

Definition at line 112 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

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

Definition at line 47 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

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

Definition at line 52 of file BackendLayout.php.

Referenced by TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\getData(), and TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\setData().

◆ $description

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

Definition at line 37 of file BackendLayout.php.

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

◆ $iconPath

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

Definition at line 42 of file BackendLayout.php.

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

◆ $identifier

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

Definition at line 27 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\getIdentifier(), and TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\setIdentifier().

◆ $title

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

Definition at line 32 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\getTitle(), and TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\setTitle().