PHP Class Piwik\Report\ReportWidgetConfig

Inheritance: extends Piwik\Widget\WidgetConfig

Show file Open project: piwik/piwik Class Usage Examples

Protected Properties

Property	Type	Description
$forceViewDataTable
$viewDataTable

Public Methods

Method	Description
forceViewDataTable ( string $viewDataTableId )	Forces the usage of the given viewDataTable in order to render the report.
getParameters ( )
getViewDataTable ( ) : string	Get the specified viewDataTable.
isViewDataTableForced ( ) : boolean	Detect whether a defined viewDataTable should be forced in order to render a report.
setDefaultViewDataTable ( string $viewDataTableId ) : static	Sets a default viewDataTable that should be used to render the report. This is not neccessarily the view that will be actually used to render the report. Eg if a user switched manually to another viewDataTable Piwik will re-use the viewDataTable that was used the last time. If you want to force the usage of a viewDataTable use {@link forceViewDataTable()}.

Method Details

forceViewDataTable() public method

Forces the usage of the given viewDataTable in order to render the report.

public forceViewDataTable ( string $viewDataTableId )
$viewDataTableId	string	eg 'table' or 'graph'

getParameters() public method

public getParameters ( )

getViewDataTable() public method

Get the specified viewDataTable.

public getViewDataTable ( ) : string
return	string

isViewDataTableForced() public method

Detect whether a defined viewDataTable should be forced in order to render a report.

public isViewDataTableForced ( ) : boolean
return	boolean

setDefaultViewDataTable() public method

Sets a default viewDataTable that should be used to render the report. This is not neccessarily the view that will be actually used to render the report. Eg if a user switched manually to another viewDataTable Piwik will re-use the viewDataTable that was used the last time. If you want to force the usage of a viewDataTable use {@link forceViewDataTable()}.

public setDefaultViewDataTable ( string $viewDataTableId ) : static
$viewDataTableId	string	eg 'table' or 'graph'
return	static

Property Details

$forceViewDataTable protected property

protected $forceViewDataTable

$viewDataTable protected property

protected $viewDataTable