DashboardRow extends Model
Row entity for operate with dashboard row table and with it's references
Table of Contents
Constants
- ATTRIBUTE_SLICE_DELIMITER = '__'
Methods
- __call() : void
- Implement delete and add actions for nested relations.
- __construct() : mixed
- Model constructor.
- addWidgets() : void
- delete() : bool|null
- deleteReports() : void
- factoryWithHorizontalCells() : mixed
- getBoardId() : string
- getClassName() : string
- getCopyForCurrentUser() : DashboardRow
- getCreatedAt() : DateTime
- getCurrentDbState() : array<string|int, mixed>
- getCurrentUserRowByGId() : DashboardRow
- Laod current users row by row gId.
- getDashboard() : Dashboard
- getErrors() : array<string|int, mixed>
- Get Errors collections.
- getGId() : string
- getId() : mixed
- getLayoutMap() : array<string|int, mixed>
- getMapAttributes() : array<string|int, mixed>
- Returns the list of pair for mapping data and object properties.
- getMapReferenceAttributes() : array<string|int, mixed>
- Returns map of lazy loaded attributes of current model.
- getRowsByGIdsAndBoardId() : array<string|int, static>
- Load Rows list by board id and rows gIds.
- getRowsWithReportsByBoard() : array<string|int, static>
- Get rows with nested widgets and reprts.
- getRowsWithWidgetsByBoard() : array<string|int, static>
- Load and return rows list by board id.
- getTableClassName() : string
- Gets the fully qualified name of table class which belongs to current model.
- getUpdatedAt() : DateTime
- getWeight() : int
- getWidgets() : array<string|int, Widget>
- load() : static
- loadAttribute() : void
- loadByGId() : static
- Load and return row by gId.
- loadById() : static
- save() : Model
- setBoardId() : void
- Setter for board id.
- setCreatedAt() : void
- setGId() : void
- Setter for gId value.
- setId() : void
- setLayoutMap() : void
- Serialize and set layout map array.
- setUpdatedAt() : void
- setWeight() : void
- Setter of Weight in rows list of dashboard. (for sorting).
Constants
ATTRIBUTE_SLICE_DELIMITER
public
mixed
ATTRIBUTE_SLICE_DELIMITER
= '__'
Methods
__call()
Implement delete and add actions for nested relations.
public
__call(string $name, array<string|int, mixed> $arguments) : void
Parameters
- $name : string
-
Getter name.
- $arguments : array<string|int, mixed>
-
Arguments passed to getter.
__construct()
Model constructor.
public
__construct() : mixed
addWidgets()
public
addWidgets(Widget|array<string|int, Widgets> $widget) : void
add widget/widgets to this row
Parameters
- $widget : Widget|array<string|int, Widgets>
delete()
public
delete() : bool|null
Return values
bool|nulldeleteReports()
public
deleteReports(Widget|array<string|int, Widgets> $widget) : void
delete widget connection and if it is ONE-TO-MANY delete Widget entity
Parameters
- $widget : Widget|array<string|int, Widgets>
factoryWithHorizontalCells()
public
static factoryWithHorizontalCells([mixed $cellCount = 1 ]) : mixed
Parameters
- $cellCount : mixed = 1
getBoardId()
public
getBoardId() : string
Return values
stringgetClassName()
public
static getClassName() : string
Return values
stringgetCopyForCurrentUser()
public
getCopyForCurrentUser() : DashboardRow
Return values
DashboardRowgetCreatedAt()
public
getCreatedAt() : DateTime
Return values
DateTimegetCurrentDbState()
public
getCurrentDbState() : array<string|int, mixed>
Return values
array<string|int, mixed>getCurrentUserRowByGId()
Laod current users row by row gId.
public
static getCurrentUserRowByGId(string $rowGId) : DashboardRow
Parameters
- $rowGId : string
-
Value of row gId.
Return values
DashboardRowgetDashboard()
public
getDashboard() : Dashboard
Return values
DashboardgetErrors()
Get Errors collections.
public
getErrors() : array<string|int, mixed>
Return values
array<string|int, mixed>getGId()
public
getGId() : string
Return values
stringgetId()
public
getId() : mixed
getLayoutMap()
public
getLayoutMap() : array<string|int, mixed>
Return values
array<string|int, mixed>getMapAttributes()
Returns the list of pair for mapping data and object properties.
public
static getMapAttributes() : array<string|int, mixed>
Key is field in DataManager, value is object property.
Return values
array<string|int, mixed>getMapReferenceAttributes()
Returns map of lazy loaded attributes of current model.
public
static getMapReferenceAttributes() : array<string|int, mixed>
Return values
array<string|int, mixed>getRowsByGIdsAndBoardId()
Load Rows list by board id and rows gIds.
public
static getRowsByGIdsAndBoardId(array<string|int, mixed> $gIds, string $boardId) : array<string|int, static>
Parameters
- $gIds : array<string|int, mixed>
-
Collection of gIds.
- $boardId : string
-
Board id.
Return values
array<string|int, static>getRowsWithReportsByBoard()
Get rows with nested widgets and reprts.
public
static getRowsWithReportsByBoard(string $boardId) : array<string|int, static>
Parameters
- $boardId : string
-
Board id.
Return values
array<string|int, static>getRowsWithWidgetsByBoard()
Load and return rows list by board id.
public
static getRowsWithWidgetsByBoard(string $boardId) : array<string|int, static>
Parameters
- $boardId : string
-
Board id.
Return values
array<string|int, static>getTableClassName()
Gets the fully qualified name of table class which belongs to current model.
public
static getTableClassName() : string
Return values
stringgetUpdatedAt()
public
getUpdatedAt() : DateTime
Return values
DateTimegetWeight()
public
getWeight() : int
Return values
intgetWidgets()
public
getWidgets() : array<string|int, Widget>
Return values
array<string|int, Widget>load()
public
static load(array<string|int, mixed>|ConditionTree $filter[, array<string|int, mixed> $with = array() ][, array<string|int, mixed> $order = array() ]) : static
Parameters
- $filter : array<string|int, mixed>|ConditionTree
-
Filter parameters.
- $with : array<string|int, mixed> = array()
-
Relation keys to load.
- $order : array<string|int, mixed> = array()
-
Order parameters.
Return values
staticloadAttribute()
public
loadAttribute(string $attributeName) : void
Parameters
- $attributeName : string
-
Attribute name to load to property from db.
loadByGId()
Load and return row by gId.
public
static loadByGId(string $gId) : static
Parameters
- $gId : string
-
Row gId.
Return values
staticloadById()
public
static loadById(mixed $id) : static
Parameters
- $id : mixed
-
Load entity by id.
Return values
staticsave()
public
save() : Model
Return values
ModelsetBoardId()
Setter for board id.
public
setBoardId(string $boardId) : void
Parameters
- $boardId : string
-
Board id.
setCreatedAt()
public
setCreatedAt(DateTime $createdAt) : void
Parameters
- $createdAt : DateTime
-
Record create time.
setGId()
Setter for gId value.
public
setGId(string $gId) : void
Parameters
- $gId : string
-
Value of gId.
setId()
public
setId(mixed $id) : void
Parameters
- $id : mixed
-
Id property value.
setLayoutMap()
Serialize and set layout map array.
public
setLayoutMap(array<string|int, mixed> $layoutMap) : void
Parameters
- $layoutMap : array<string|int, mixed>
-
Layout map.
setUpdatedAt()
public
setUpdatedAt(DateTime $updatedAt) : void
Parameters
- $updatedAt : DateTime
-
Record update time.
setWeight()
Setter of Weight in rows list of dashboard. (for sorting).
public
setWeight(mixed $weight) : void
Parameters
- $weight : mixed
-
Weight of report.