All Data Structures Functions Variables Pages
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes
ChartDataProvider Class Reference
Inheritance diagram for ChartDataProvider:
MarketingChartDataProvider OpportunitiesBySourceChartDataProvider OpportunitiesByStageChartDataProvider MarketingGroupByEmailMessagesChartDataProvider MarketingListGrowthChartDataProvider AutoresponderGroupedChartDataProvider MarketingEmailsInThisListChartDataProvider MarketingListPerformanceChartDataProvider

Public Member Functions

 getXAxisName ()
 
 getYAxisName ()
 
 getChartData ()
 
 getModel ()
 

Protected Member Functions

 resolveCurrencyValueConversionRateForCurrentUserForDisplay ($valueInBaseCurrency)
 

Static Protected Member Functions

static resolveLabelByValueAndLabels ($value, $labels)
 

Protected Attributes

 $model
 

Detailed Description

Base class for creating Chart data providers. Chart data providers produce arrays of data that can be adapted into a charting library for output to the user interface.

Definition at line 41 of file ChartDataProvider.php.

Member Function Documentation

getXAxisName ( )
abstract

Get the locale translated X Axis display name for a chart.

getYAxisName ( )
abstract

Get the locale translated Y Axis display name for a chart.

getChartData ( )
abstract

Run a query and produce a data set as an array.

Returns
array of data.
resolveCurrencyValueConversionRateForCurrentUserForDisplay (   $valueInBaseCurrency)
protected

Given a value that is in the base currency, convert the value to the display currency for the current user.

Parameters
Number$valueInBaseCurrency

Definition at line 70 of file ChartDataProvider.php.


The documentation for this class was generated from the following file:
Generated on Sun Jan 26 2020 07:10:29