API Reference

ReportsProvider

Piwik\Plugin\

ReportsProvider

Get reports that are defined by plugins.

Methods

The class defines the following methods:

  • factory() — Get an instance of a specific report belonging to the given module and having the given action.
  • getAllReports() — Returns a list of all available reports.
  • getAllReportClasses() — Returns class names of all Report metadata classes.

factory()

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

Signature

  • It accepts the following parameter(s):

    • $module (string) —

    • $action (string) —

  • Returns: null|Report —

getAllReports()

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.

Signature

getAllReportClasses()

Returns class names of all Report metadata classes.

Signature

  • It returns a string[] value.