CatalogDashboard
AbstractYes
Instances of this class must be provided from DashboardManager, that make access validation before this
Table of Contents
Constants
- BUTCH_GROUP = 'catalog_general'
- BUTCH_GROUP_SORT = 160
Methods
- __construct() : mixed
- addView() : void
- Add view to dashboard that will show in <b>$weight</b> order to page
- bindGroup() : void
- getAccessBoardId() : string
- Returns identified <b>access board id</b> for catalog access checking
- getActiveViewList() : array<string|int, mixed>
- getAnalyticBoard() : AnalyticBoard
- getAnalyticBoardBatch() : AnalyticBoardBatch
- getBoardKey() : string
- Returns identified <b>board key</b> for dashboard instance
- getBoardTitle() : string|null
- getBoardVersion() : string
- Returns <b>board version</b> of dashboard instance
- getDashboard() : Dashboard
- getGroup() : Group
- getHandler() : BaseHandler
- getRows() : array<string|int, mixed>
- setHandler() : void
Constants
BUTCH_GROUP
public
mixed
BUTCH_GROUP
= 'catalog_general'
BUTCH_GROUP_SORT
public
mixed
BUTCH_GROUP_SORT
= 160
Methods
__construct()
public
__construct() : mixed
addView()
Add view to dashboard that will show in <b>$weight</b> order to page
public
addView(View $view, int $weight) : void
Parameters
- $view : View
- $weight : int
bindGroup()
public
bindGroup(Group $group) : void
Parameters
- $group : Group
getAccessBoardId()
Returns identified <b>access board id</b> for catalog access checking
public
abstract getAccessBoardId() : string
Return values
stringgetActiveViewList()
public
getActiveViewList() : array<string|int, mixed>
Return values
array<string|int, mixed>getAnalyticBoard()
public
getAnalyticBoard() : AnalyticBoard
Return values
AnalyticBoardgetAnalyticBoardBatch()
public
getAnalyticBoardBatch() : AnalyticBoardBatch
Return values
AnalyticBoardBatchgetBoardKey()
Returns identified <b>board key</b> for dashboard instance
public
abstract getBoardKey() : string
Return values
stringgetBoardTitle()
public
abstract getBoardTitle() : string|null
Return values
string|nullgetBoardVersion()
Returns <b>board version</b> of dashboard instance
public
abstract getBoardVersion() : string
Return values
stringgetDashboard()
public
getDashboard() : Dashboard
Return values
DashboardgetGroup()
public
getGroup() : Group
Return values
GroupgetHandler()
public
getHandler() : BaseHandler
Return values
BaseHandlergetRows()
public
getRows() : array<string|int, mixed>
Return values
array<string|int, mixed>setHandler()
public
setHandler(BaseHandler $handler) : void
Parameters
- $handler : BaseHandler