PHP Class Piwik\Plugins\Dashboard\Dashboard

Inheritance: extends Piwik\Plugin
Show file Open project: piwik/piwik Class Usage Examples

Public Methods

Method Description
addSubcategories ( &$subcategories )
addWidgetConfigs ( &$widgets )
decodeLayout ( $layout )
deleteDashboardLayout ( $userLogin )
encodeLayout ( $layout )
getAllDashboards ( $login )
getClientSideTranslationKeys ( &$translationKeys )
getDefaultLayout ( )
getJsFiles ( &$jsFiles )
getLayoutForUser ( string $login, integer $idDashboard ) : boolean | string Returns the layout in the DB for the given user, or false if the layout has not been set yet.
getStylesheetFiles ( &$stylesheets )
install ( )
registerEvents ( )
removeDisabledPluginFromLayout ( $layout )
uninstall ( )

Private Methods

Method Description
addDefaultDashboard ( &$widgets )
addDefaultSubcategory ( &$subcategories )
getModel ( )
isAlreadyDecodedLayout ( $layout )

Method Details

addSubcategories() public method

public addSubcategories ( &$subcategories )

addWidgetConfigs() public method

public addWidgetConfigs ( &$widgets )

decodeLayout() public method

public decodeLayout ( $layout )

deleteDashboardLayout() public method

public deleteDashboardLayout ( $userLogin )

encodeLayout() public method

public encodeLayout ( $layout )

getAllDashboards() public method

public getAllDashboards ( $login )

getClientSideTranslationKeys() public method

public getClientSideTranslationKeys ( &$translationKeys )

getDefaultLayout() public method

public getDefaultLayout ( )

getJsFiles() public method

public getJsFiles ( &$jsFiles )

getLayoutForUser() public method

Parameters must be checked BEFORE this function call
public getLayoutForUser ( string $login, integer $idDashboard ) : boolean | string
$login string
$idDashboard integer
return boolean | string

getStylesheetFiles() public method

public getStylesheetFiles ( &$stylesheets )

install() public method

public install ( )

registerEvents() public method

See also: Piwik\Plugin::registerEvents
public registerEvents ( )

removeDisabledPluginFromLayout() public method

public removeDisabledPluginFromLayout ( $layout )

uninstall() public method

public uninstall ( )