Dashboard\Classes\CmsReportDataSource
Overview
CmsReportDataSource providing information about the website traffic.
Extends
Public Properties
There are no public properties in the class.
Show inherited public properties
Inherited Public Properties
- $vars - is a list of variables to pass to the page. (defined in Dashboard\Classes\ReportDataSourceBase)
- $layout - to use for the view. (defined in Dashboard\Classes\ReportDataSourceBase)
- $suppressLayout - prevents the use of a layout. (defined in Dashboard\Classes\ReportDataSourceBase)
Protected Properties
There are no protected properties in the class.
Show inherited protected properties
Inherited Protected Properties
- $viewPath - specifies a path to the views directory. (defined in Dashboard\Classes\ReportDataSourceBase)
- $layoutPath - specifies a path to the layout directory. (defined in Dashboard\Classes\ReportDataSourceBase)
- $viewPathGuessCache - remembers path guesses for performance. (defined in Dashboard\Classes\ReportDataSourceBase)
Public Methods
public __construct()
public __construct(): void
__construct the data source
Inherited Public Methods
- addViewPath() - prepends a path on the available view path locations. (defined in Dashboard\Classes\ReportDataSourceBase)
- getAvailableDimensions() - returns the available dimensions for this data source. (defined in Dashboard\Classes\ReportDataSourceBase)
- getAvailableMetrics() - returns the available metrics for this data source. (defined in Dashboard\Classes\ReportDataSourceBase)
- getData() - returns the data for the specified report. (defined in Dashboard\Classes\ReportDataSourceBase)
- getViewPath() - locates a file based on its definition. The file name can be prefixed. (defined in Dashboard\Classes\ReportDataSourceBase)
- getViewPaths() - returns the active view path locations. (defined in Dashboard\Classes\ReportDataSourceBase)
- guessViewPath() - guesses the package path for the called class. (defined in Dashboard\Classes\ReportDataSourceBase)
- guessViewPathFrom() - guesses the package path from a specified class, including. (defined in Dashboard\Classes\ReportDataSourceBase)
- makeFileContents() - includes a file path using output buffering. (defined in Dashboard\Classes\ReportDataSourceBase)
- makeLayout() - renders a layout. (defined in Dashboard\Classes\ReportDataSourceBase)
- makeLayoutPartial() - renders a layout partial. (defined in Dashboard\Classes\ReportDataSourceBase)
- makePartial() - renders a partial file contents located in the views folder. (defined in Dashboard\Classes\ReportDataSourceBase)
- makeView() - loads a view with the name specified. Applies layout if its name is provided. (defined in Dashboard\Classes\ReportDataSourceBase)
- makeViewContent() - renders supplied contents inside a layout. (defined in Dashboard\Classes\ReportDataSourceBase)
- runHandler() - runs a data source event handler. (defined in Dashboard\Classes\ReportDataSourceBase)
Protected Methods
protected fetchData()
protected fetchData($data): Dashboard\Classes\ReportFetchDataResult
Show inherited protected methods
Inherited Protected Methods
- addCalculatedDimension() - is a shorthand version of registerDimension. (defined in Dashboard\Classes\ReportDataSourceBase)
- handleViewException() - handles a view exception. (defined in Dashboard\Classes\ReportDataSourceBase)
- makeResultRow() - helps format a result row expected in the fetchData return value. (defined in Dashboard\Classes\ReportDataSourceBase)
- registerDimension() - registers a new dimension. (defined in Dashboard\Classes\ReportDataSourceBase)
- registerMetric() - registers a new common metric. (defined in Dashboard\Classes\ReportDataSourceBase)