Dashboard
Class Dashboard
Table of Contents
Methods
- addWidgetToDashboardsWithKey() : array<string|int, mixed>
- Add this widget to end of all boards with key $boardKey.
- getBoardModeIsDemo() : bool
- getDashboardByKeyForCurrentUser() : Dashboard
- Try find dashboard with key for this user, if not exist create it from copy of default board and return.
- renewDefaultDashboard() : void
- This method is for service.
- setBoardModeIsDemo() : mixed
- updateBoardCustomDefaultMode() : mixed
Methods
addWidgetToDashboardsWithKey()
Add this widget to end of all boards with key $boardKey.
public
static addWidgetToDashboardsWithKey(string $boardKey, Widget $widget) : array<string|int, mixed>
will create new row and place there $widget.
Parameters
- $boardKey : string
-
Board key.
- $widget : Widget
-
Widget entity.
Return values
array<string|int, mixed>getBoardModeIsDemo()
public
static getBoardModeIsDemo(mixed $boardKey) : bool
Parameters
- $boardKey : mixed
Return values
boolgetDashboardByKeyForCurrentUser()
Try find dashboard with key for this user, if not exist create it from copy of default board and return.
public
static getDashboardByKeyForCurrentUser(string $boardKey) : Dashboard
Parameters
- $boardKey : string
-
Board key.
Return values
DashboardrenewDefaultDashboard()
This method is for service.
public
static renewDefaultDashboard(string $boardKey) : void
Find all default dashboards in product. Check if version change, then remove dashboard with all nested entities, and isnert new.
Parameters
- $boardKey : string
-
Board key.
Tags
setBoardModeIsDemo()
public
static setBoardModeIsDemo(mixed $boardKey, mixed $mode) : mixed
Parameters
- $boardKey : mixed
- $mode : mixed
updateBoardCustomDefaultMode()
public
static updateBoardCustomDefaultMode(mixed $boardKey[, mixed $demo = false ]) : mixed
Parameters
- $boardKey : mixed
- $demo : mixed = false