PHP Class Piwik\ViewDataTable\Manager

Show file Open project: piwik/piwik Class Usage Examples

Public Methods

Method	Description
clearAllViewDataTableParameters ( )
clearUserViewDataTableParameters ( $userLogin )
configureFooterIcons ( ViewDataTable $view )	This method determines the default set of footer icons to display below a report.
getAvailableViewDataTables ( ) : array	Returns all registered visualization classes. Uses the 'Visualization.getAvailable' event to retrieve visualizations.
getIdsWithInheritance ( string $klass ) : array	Returns the viewDataTable IDs of a visualization's class lineage.
getNonCoreViewDataTables ( ) : array	Returns all available visualizations that are not part of the CoreVisualizations plugin.
getViewDataTableParameters ( $login, $controllerAction )
saveViewDataTableParameters ( $login, $controllerAction, $parametersToOverride )	Any parameter set here will be set into one of the following objects:

Private Methods

Method	Description
buildViewDataTableParametersOptionKey ( $login, $controllerAction )
errorWhenSettingNonOverridableParameter ( $controllerAction, $params )	Display a meaningful error message when any invalid parameter is being set.
getFooterIconFor ( string $viewDataTableId ) : array	Returns an array with information necessary for adding the viewDataTable to the footer.
getGraphViewIcons ( ViewDataTable $view )
getNormalViewIcons ( ViewDataTable $view )
makeTemporaryViewDataTableInstance ( $controllerAction, $params ) : ViewDataTable
removeNonOverridableParameters ( $controllerAction, $params )

Method Details

clearAllViewDataTableParameters() public static method

public static clearAllViewDataTableParameters ( )

clearUserViewDataTableParameters() public static method

public static clearUserViewDataTableParameters ( $userLogin )

configureFooterIcons() public static method

$result has the following format: array( array( // footer icon group 1 'class' => 'footerIconGroup1CssClass', 'buttons' => array( 'id' => 'myid', 'title' => 'My Tooltip', 'icon' => 'path/to/my/icon.png' ) ), array( // footer icon group 2 'class' => 'footerIconGroup2CssClass', 'buttons' => array(...) ), ... )

public static configureFooterIcons ( ViewDataTable $view )
$view	Piwik\Plugin\ViewDataTable

getAvailableViewDataTables() public static method

Returns all registered visualization classes. Uses the 'Visualization.getAvailable' event to retrieve visualizations.

public static getAvailableViewDataTables ( ) : array
return	array	Array mapping visualization IDs with their associated visualization classes.

getIdsWithInheritance() public static method

Returns the viewDataTable IDs of a visualization's class lineage.

See also: self::getVisualizationClassLineage

public static getIdsWithInheritance ( string $klass ) : array
$klass	string	The visualization class.
return	array

getNonCoreViewDataTables() public static method

Returns all available visualizations that are not part of the CoreVisualizations plugin.

public static getNonCoreViewDataTables ( ) : array
return	array	Array mapping visualization IDs with their associated visualization classes.

getViewDataTableParameters() public static method

public static getViewDataTableParameters ( $login, $controllerAction )

saveViewDataTableParameters() public static method

- ViewDataTable.requestConfig[paramName] - ViewDataTable.config.custom_parameters[paramName] - ViewDataTable.config.custom_parameters[paramName] (see ViewDataTable::overrideViewPropertiesWithParams)

public static saveViewDataTableParameters ( $login, $controllerAction, $parametersToOverride )
$login
$controllerAction
$parametersToOverride