BackendLayout
class \
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
= ''
$data
protected
array
$data
= []
$description
protected
string
$description
= ''
$iconPath
protected
string
$iconPath
= ''
$identifier
protected
string
$identifier
$structure
The structured data of the configuration represented as array.
protected
array
$structure
= []
$title
protected
string
$title
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
BackendLayoutgetColCount()
public
getColCount() : int
Return values
intgetColumnPositionNumbers()
public
getColumnPositionNumbers() : string[]
Return values
string[]getConfiguration()
public
getConfiguration() : string
Return values
stringgetData()
public
getData() : array
Return values
arraygetDescription()
public
getDescription() : string
Return values
stringgetIconPath()
public
getIconPath() : string
Return values
stringgetIdentifier()
public
getIdentifier() : string
Return values
stringgetIdentifierCleaned()
public
getIdentifierCleaned() : string
Return values
stringgetRowCount()
public
getRowCount() : int
Return values
intgetStructure()
public
getStructure() : array
Return values
arraygetTitle()
public
getTitle() : string
Return values
stringgetUsedColumns()
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
arraysetConfiguration()
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