PHP Class Piwik\Plugin\ReportsProvider

Show file Open project: piwik/piwik Class Usage Examples

Public Methods

Method	Description
compareCategories ( $catIdA, $subcatIdA, $orderA, $catIdB, $subcatIdB, $orderB )
factory ( string $module, string $action ) : null \| Report	Get an instance of a specific report belonging to the given module and having the given action.
getAllReportClasses ( ) : string[]	Returns class names of all Report metadata classes.
getAllReports ( ) : Report[]	Returns a list of all available reports. Even not enabled reports will be returned. They will be already sorted depending on the order and category of the report.

Private Methods

Method	Description
getMapOfModuleActionsToReport ( )
sort ( Report $a, Report $b ) : integer	API metadata are sorted by category/name, with a little tweak to replicate the standard Piwik category ordering

Method Details

compareCategories() public method

public compareCategories ( $catIdA, $subcatIdA, $orderA, $catIdB, $subcatIdB, $orderB )

factory() public static method

Get an instance of a specific report belonging to the given module and having the given action.

public static factory ( string $module, string $action ) : null \| Report
$module	string
$action	string
return	null \| Report

getAllReportClasses() public method

Returns class names of all Report metadata classes.

public getAllReportClasses ( ) : string[]
return	string[]

getAllReports() public method

Returns a list of all available reports. Even not enabled reports will be returned. They will be already sorted depending on the order and category of the report.

public getAllReports ( ) : Report[]
return	Report[]