BackendLayout

Class to represent a backend layout.

Table of Contents

Properties

$configuration  : string
$data  : array<string|int, mixed>
$description  : string
$iconPath  : string
$identifier  : string
$structure  : array<string|int, mixed>
The structured data of the configuration represented as array.
$title  : string

Methods

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

Properties

$configuration

protected string $configuration

$data

protected array<string|int, mixed> $data

$structure

The structured data of the configuration represented as array.

protected array<string|int, mixed> $structure = []

Methods

__construct()

public __construct(string $identifier, string $title, string|array<string|int, mixed> $configuration) : mixed
Parameters
$identifier : string
$title : string
$configuration : string|array<string|int, mixed>

create()

public static create(string $identifier, string $title, string|array<string|int, mixed> $configuration) : BackendLayout
Parameters
$identifier : string
$title : string
$configuration : string|array<string|int, mixed>
Return values
BackendLayout

getColCount()

public getColCount() : int
Return values
int

getColumnPositionNumbers()

public getColumnPositionNumbers() : array<string|int, string>
Return values
array<string|int, string>

getConfiguration()

public getConfiguration() : string
Return values
string

getData()

public getData() : array<string|int, mixed>
Return values
array<string|int, mixed>

getDescription()

public getDescription() : string
Return values
string

getIconPath()

public getIconPath() : string
Return values
string

getIdentifier()

public getIdentifier() : string
Return values
string

getRowCount()

public getRowCount() : int
Return values
int

getStructure()

public getStructure() : array<string|int, mixed>
Return values
array<string|int, mixed>

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<string|int, mixed>

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

Return values
array<string|int, mixed>

setConfiguration()

public setConfiguration(string $configuration) : mixed
Parameters
$configuration : string

setData()

public setData(array<string|int, mixed> $data) : mixed
Parameters
$data : array<string|int, mixed>

setDescription()

public setDescription(string $description) : mixed
Parameters
$description : string

setIconPath()

public setIconPath(string $iconPath) : mixed
Parameters
$iconPath : string

setIdentifier()

public setIdentifier(string $identifier) : mixed
Parameters
$identifier : string
Tags
throws
UnexpectedValueException

setStructure()

public setStructure(array<string|int, mixed> $structure) : mixed
Parameters
$structure : array<string|int, mixed>

setTitle()

public setTitle(string $title) : mixed
Parameters
$title : string 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results