Documentation

Dashboard
in package

Dashboard model class.

Table of Contents

$supportedWidgetsTypes  : array<string|int, string>
$application  : int
$dashboardType  : int
$moduleName  : string
getChartFilter()  : array<string|int, mixed>
Get chart filter widget data.
getData()  : array<string|int, mixed>
Return data about all added widgets in this dashboard.
getInstance()  : self
Function to get instance.
getMiniList()  : array<string|int, mixed>
Get mini list widget data.
getTabs()  : array<string|int, mixed>
Gets tabs.
setDashboard()  : $this
Set dashboard ID.

Properties

$supportedWidgetsTypes

public static array<string|int, string> $supportedWidgetsTypes = ['Mini List' => 'getMiniList', 'ChartFilter' => 'getChartFilter']

Id application.

$application

protected int $application

Id application.

$dashboardType

protected int $dashboardType

Type of dashboard.

$moduleName

protected string $moduleName

Module name.

Methods

getChartFilter()

Get chart filter widget data.

public getChartFilter(array<string|int, mixed> $row) : array<string|int, mixed>
Parameters
$row : array<string|int, mixed>
Return values
array<string|int, mixed>

getData()

Return data about all added widgets in this dashboard.

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

getInstance()

Function to get instance.

public static getInstance(string $moduleName, int $dashboardType, int $application) : self
Parameters
$moduleName : string
$dashboardType : int
$application : int
Return values
self

getMiniList()

Get mini list widget data.

public getMiniList(array<string|int, mixed> $row) : array<string|int, mixed>
Parameters
$row : array<string|int, mixed>
Return values
array<string|int, mixed>

getTabs()

Gets tabs.

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

setDashboard()

Set dashboard ID.

public setDashboard(int $dashboardType) : $this
Parameters
$dashboardType : int
Return values
$this

        

Search results