PHP Class Piwik\Plugins\Dashboard\API

Inheritance: extends Piwik\Plugin\API

Show file Open project: piwik/piwik Class Usage Examples

Public Methods

Method	Description
__construct ( Dashboard $dashboard )
getDashboards ( ) : array[]	Get each dashboard that belongs to a user including the containing widgets that are placed within each dashboard.

Private Methods

Method	Description
buildDashboard ( $dashboard, $widgets )
getColumnsFromDashboard ( $dashboard )
getDefaultDashboard ( ) : array[]	Get the default dashboard.
getUserDashboards ( ) : array[]	Get all dashboards which a user has created.
getVisibleWidgetsWithinDashboard ( $dashboard )
widgetIsNotHidden ( $widget )

Method Details

__construct() public method

public __construct ( Dashboard $dashboard )
$dashboard	Dashboard

getDashboards() public method

If the user has not created any dashboard yet, the default dashboard will be returned.

public getDashboards ( ) : array[]
return	array[]