PHP Class Piwik\Plugins\Dashboard\Controller

Inheritance: extends piwik\plugin\Controller
Show file Open project: piwik/piwik

Public Methods

Method Description
copyDashboardToUser ( )
createNewDashboard ( ) Creates a new dashboard for the current user User needs to be logged in
embeddedIndex ( ) this
getAllDashboards ( ) Outputs all available dashboards for the current user as a JSON string
getDashboardLayout ( $checkToken = true )
index ( ) this is the exported widget
removeDashboard ( ) Removes the dashboard with the given id
resetLayout ( ) Resets the dashboard to the default widget configuration
saveLayout ( ) Saves the layout for the current user anonymous = in the session authenticated user = in the DB
saveLayoutAsDefault ( ) Saves the layout as default

Protected Methods

Method Description
_getDashboardView ( $template )
getAvailableLayouts ( ) : array Returns all available column layouts for the dashboard
getLayout ( integer $idDashboard ) : string Get the dashboard layout for the current user (anonymous or logged user)
init ( )

Private Methods

Method Description
getModel ( )

Method Details

_getDashboardView() protected method

protected _getDashboardView ( $template )

copyDashboardToUser() public method

public copyDashboardToUser ( )

createNewDashboard() public method

Creates a new dashboard for the current user User needs to be logged in
public createNewDashboard ( )

embeddedIndex() public method

this
public embeddedIndex ( )

getAllDashboards() public method

Outputs all available dashboards for the current user as a JSON string
public getAllDashboards ( )

getAvailableLayouts() protected method

Returns all available column layouts for the dashboard
protected getAvailableLayouts ( ) : array
return array

getDashboardLayout() public method

public getDashboardLayout ( $checkToken = true )

getLayout() protected method

Get the dashboard layout for the current user (anonymous or logged user)
protected getLayout ( integer $idDashboard ) : string
$idDashboard integer
return string $layout

index() public method

this is the exported widget
public index ( )

init() protected method

protected init ( )

removeDashboard() public method

Removes the dashboard with the given id
public removeDashboard ( )

resetLayout() public method

Resets the dashboard to the default widget configuration
public resetLayout ( )

saveLayout() public method

Saves the layout for the current user anonymous = in the session authenticated user = in the DB
public saveLayout ( )

saveLayoutAsDefault() public method

Saves the layout as default
public saveLayoutAsDefault ( )