ChartForReportForm Class Reference

Inheritance diagram for ChartForReportForm:
ConfigurableMetadataModel

Public Member Functions

 rules ()
 attributeLabels ()
 __construct ($availableSeriesDataAndLabels=array(), $availableRangeDataAndLabels=array())
 validateSeriesAndRange ()
 getTypeDataAndLabels ()
 getAvailableFirstSeriesDataAndLabels ()
 getAvailableFirstRangeDataAndLabels ()
 getAvailableSecondSeriesDataAndLabels ()
 getAvailableSecondRangeDataAndLabels ()

Data Fields

 $type
 $firstSeries
 $firstRange
 $secondSeries
 $secondRange

Detailed Description

Class that defines the chart for use by summation reports. A chart is optional.

Definition at line 40 of file ChartForReportForm.php.


Constructor & Destructor Documentation

__construct ( availableSeriesDataAndLabels = array(),
availableRangeDataAndLabels = array() 
)

Depending on other report definitions, a chart may or may not be available. When creating a chart, define the available series and ranges based on those definitions. For example, if you have not selected a grouping, then there would be no available series.

Parameters:
array $availableSeriesDataAndLabels
array $availableRangeDataAndLabels

Definition at line 113 of file ChartForReportForm.php.


Member Function Documentation

validateSeriesAndRange (  ) 

Validates that the first and second series/ranges are properly formed.

Returns:
bool

Definition at line 125 of file ChartForReportForm.php.

getTypeDataAndLabels (  ) 

Returns array of chart types and their corresponding labels

Returns:
array

Definition at line 168 of file ChartForReportForm.php.

getAvailableFirstSeriesDataAndLabels (  ) 
Returns:
array

Definition at line 182 of file ChartForReportForm.php.

getAvailableFirstRangeDataAndLabels (  ) 
Returns:
array

Definition at line 190 of file ChartForReportForm.php.

getAvailableSecondSeriesDataAndLabels (  ) 
Returns:
array

Definition at line 198 of file ChartForReportForm.php.

getAvailableSecondRangeDataAndLabels (  ) 
Returns:
array

Definition at line 206 of file ChartForReportForm.php.


The documentation for this class was generated from the following file:
 All Data Structures Functions Variables
Generated on Thu Jun 22 07:10:23 2017