Widget
Class Widget
Table of Contents
Constants
- LAZY_LOAD_MODE = true
Methods
- constructNewPseudoWidgetByParams() : Widget
- Construct Pseudo widget by form params, to render preview in previewBlock.
- constructPseudoWidgetByParams() : Widget
- Construct widget by params.
- getCalculatedPerformedData() : null
- prepareBoardWithEntitiesByBoardId() : array<string|int, mixed>
- Load all dashboard by board key.
- prepareWidgetContent() : array<string|int, mixed>
- Build Widget content pas to preparing in view controller.
- saveWidgetAsCurrentUserPattern() : Widget
- Get copy from core widget. set net gId. and save.
Constants
LAZY_LOAD_MODE
public
mixed
LAZY_LOAD_MODE
= true
Methods
constructNewPseudoWidgetByParams()
Construct Pseudo widget by form params, to render preview in previewBlock.
public
static constructNewPseudoWidgetByParams(array<string|int, mixed> $params) : Widget
Parameters
- $params : array<string|int, mixed>
-
Parameters to construct new widget.
Tags
Return values
WidgetconstructPseudoWidgetByParams()
Construct widget by params.
public
static constructPseudoWidgetByParams(array<string|int, mixed> $params) : Widget
Parameters
- $params : array<string|int, mixed>
-
Parameters to construct widget.
Tags
Return values
WidgetgetCalculatedPerformedData()
public
static getCalculatedPerformedData(View $view, Widget $widget) : null
Parameters
Return values
nullprepareBoardWithEntitiesByBoardId()
Load all dashboard by board key.
public
static prepareBoardWithEntitiesByBoardId(string $boardKey) : array<string|int, mixed>
Prepare it for render.
Parameters
- $boardKey : string
-
Board key.
Return values
array<string|int, mixed>prepareWidgetContent()
Build Widget content pas to preparing in view controller.
public
static prepareWidgetContent(Widget $widget[, bool $withCalculatedData = false ]) : array<string|int, mixed>
Parameters
- $widget : Widget
-
Widget Entity.
- $withCalculatedData : bool = false
-
Marker define calculate or not data in reports.
Return values
array<string|int, mixed>saveWidgetAsCurrentUserPattern()
Get copy from core widget. set net gId. and save.
public
static saveWidgetAsCurrentUserPattern(Widget $widget[, string $categoryKey = '' ]) : Widget
Parameters
- $widget : Widget
-
Entity of core widget.
- $categoryKey : string = ''
-
kay of Category to attach pattern widget.