|
|
| Line 1: |
Line 1: |
| This article describes the class ''I2CE_CustomReport_Display_PieChart''.
| | #REDIRECT [[Class: I2CE_CustomReport_Display_PieChart (4.0.3)]] |
| *Extends the class: [[Class: I2CE_CustomReport_Display | I2CE_CustomReport_Display]].
| |
| *Location: Part of the module [[I2CE Module List#CustomReports_PieChart|CustomReports_PieChart]] in the package [https://launchpad.net/i2ce I2CE]
| |
| *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php#L29 modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php] on line 29
| |
| *Author: Carl Leitner <litlfred@ibiblio.org>
| |
| I2CE_CustomReport_Display_PDF
| |
| ==Variables==
| |
| ===$chart===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php#L35 i2ce/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php] on line 35
| |
| *Type: protected $chart
| |
| | |
| ===$displayedChartFields===
| |
| An array with values the name of the columns used for this display
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php#L238 i2ce/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php] on line 238
| |
| *Type: protected [http://www.php.net/manual/en/language.types.array.php array ] $displayedChartFields
| |
| | |
| ===$displayedChartFieldsIndices===
| |
| An array (or an array or arrays) with keys the values of the charted fields and values the index row (row and col) they are in the $chart['chart_data'] array @var protected array $displayedChartFields
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php#L244 i2ce/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php] on line 244
| |
| *Type: protected $displayedChartFieldsIndices
| |
| | |
| ==Methods==
| |
| ===canView()===
| |
| Abstract method that each display is resposbile for implementing. Checks to see if it can display the given view.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php#L384 i2ce/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php] on line 384
| |
| *Signature: protected function canView()
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
| |
| ===display()===
| |
| Display the report
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php#L45 i2ce/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php] on line 45
| |
| *Signature: public function display($contentNode,$processResults,$controls)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $contentNode <br/>The DOM node we wish to display into
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $processResults <br/>Defaults to true meaning we run through the results
| |
| ***Default Value: true
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $controls <br/>If null (default), we display all the report controsl. If string or an array of string, we only display the indicated controls
| |
| ***Default Value: null
| |
| *Returns: boolean.<br/>true on sucess
| |
| ===displayReportControl()===
| |
| Adds any controls for this display to the content node.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php#L500 i2ce/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php] on line 500
| |
| *Signature: protected function displayReportControl($contentNode)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $contentNode
| |
| *Returns: boolean;
| |
| ===ensureValidStyleAndType()===
| |
| Ensures check we have a valid style and type set or we can fall back onto one.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php#L397 i2ce/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php] on line 397
| |
| *Signature: protected function ensureValidStyleAndType($defaultOptions)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] &$defaultOptions <br/>The default options we are scanning
| |
| *Returns: boolean.<br/>True on success
| |
| ===getDefaultOptions()===
| |
| returns an array of the default display options. Default options are read and overriddenb in the following order: /modules/CustomReports/displays/$display/display_options /modules/CustomReports/relationships/display_options/$display /modules/CustomReports/reports/display_options/$display /modules/CustomReports/reportViews/$view/display_options/$display Finally any options that have a key in $get are replaced by that value
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php#L335 i2ce/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php] on line 335
| |
| *Signature: protected function getDefaultOptions($get,$options)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $get
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $options <br/>Default to the empty array. The options that we want to be already set before we start goinng through
| |
| ***Default Value: array()
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array ]
| |
| ===makeChartStylesSane()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php#L451 i2ce/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php] on line 451
| |
| *Signature: protected function makeChartStylesSane($defaultOptions)
| |
| *Parameters:
| |
| **&$defaultOptions
| |
| ===postProcessResultsMultiRow()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php#L220 i2ce/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php] on line 220
| |
| *Signature: protected function postProcessResultsMultiRow()
| |
| ===postProcessResultsOneRow()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php#L133 i2ce/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php] on line 133
| |
| *Signature: protected function postProcessResultsOneRow()
| |
| ===preProcessResultsMultiRow()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php#L214 i2ce/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php] on line 214
| |
| *Signature: protected function preProcessResultsMultiRow()
| |
| ===preProcessResultsOneRow()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php#L210 i2ce/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php] on line 210
| |
| *Signature: protected function preProcessResultsOneRow()
| |
| ===processResultRow()===
| |
| Process a result row.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php#L253 i2ce/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php] on line 253
| |
| *Signature: protected function processResultRow($row,$row_num,$contentNode)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $row
| |
| ** [http://www.php.net/manual/en/language.types.integer.php int ] $row_num <br/>The current row number when processing results. If there was a result limit, it starts the count from the beginning of the result offset. Othwerwise, it starts counting form zero.
| |
| ** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $contentNode <br/>Default to null. A node to append the result onto
| |
| ***Default Value: null
| |
| ===processResults()===
| |
| Process results
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php#L86 i2ce/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php] on line 86
| |
| *Signature: protected function processResults($results_data,$contentNode)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $results_data <br/>an array of results. indices are 'restults' and MDB2 Buffered result and 'num_results' the number of results. (these values may be false on failure)
| |
| ** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $contentNode <br/>Default to null a node to append the results onto
| |
| ***Default Value: null
| |
| ===setupFlashChart()===
| |
| Sets up the flash chart options in $this->chart
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php#L641 i2ce/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php] on line 641
| |
| *Signature: protected function setupFlashChart($defaultOptions)
| |
| *Parameters:
| |
| **&$defaultOptions
| |
| *Returns: boolean.<br/>True on success
| |
| ==Inherited Methods==
| |
| ===__construct()===
| |
| This public method is inherited from [[Class: I2CE_CustomReport_Display#__construct() | I2CE_CustomReport_Display->__construct()]]
| |
| | |
| ===saveDefaultView()===
| |
| This public method is inherited from [[Class: I2CE_CustomReport_Display#saveDefaultView() | I2CE_CustomReport_Display->saveDefaultView()]]
| |
| | |
| ===saveDisplayOptions()===
| |
| This public method is inherited from [[Class: I2CE_CustomReport_Display#saveDisplayOptions() | I2CE_CustomReport_Display->saveDisplayOptions()]]
| |
| | |
| ===displayMetaInfo()===
| |
| This protected method is inherited from [[Class: I2CE_CustomReport_Display#displayMetaInfo() | I2CE_CustomReport_Display->displayMetaInfo()]]
| |
| | |
| ===displayReportControls()===
| |
| This protected method is inherited from [[Class: I2CE_CustomReport_Display#displayReportControls() | I2CE_CustomReport_Display->displayReportControls()]]
| |
| | |
| ===displayReportLimit()===
| |
| This protected method is inherited from [[Class: I2CE_CustomReport_Display#displayReportLimit() | I2CE_CustomReport_Display->displayReportLimit()]]
| |
| | |
| ===displayReportLimits()===
| |
| This protected method is inherited from [[Class: I2CE_CustomReport_Display#displayReportLimits() | I2CE_CustomReport_Display->displayReportLimits()]]
| |
| | |
| ===findNumericFields()===
| |
| This protected method is inherited from [[Class: I2CE_CustomReport_Display#findNumericFields() | I2CE_CustomReport_Display->findNumericFields()]]
| |
| | |
| ===getBasePage()===
| |
| This protected method is inherited from [[Class: I2CE_CustomReport_Display#getBasePage() | I2CE_CustomReport_Display->getBasePage()]]
| |
| | |
| ===getDisplayFieldsData()===
| |
| This protected method is inherited from [[Class: I2CE_CustomReport_Display#getDisplayFieldsData() | I2CE_CustomReport_Display->getDisplayFieldsData()]]
| |
| | |
| ===getFormFieldObjects()===
| |
| This protected method is inherited from [[Class: I2CE_CustomReport_Display#getFormFieldObjects() | I2CE_CustomReport_Display->getFormFieldObjects()]]
| |
| | |
| ===getMappedValue()===
| |
| This protected method is inherited from [[Class: I2CE_CustomReport_Display#getMappedValue() | I2CE_CustomReport_Display->getMappedValue()]]
| |
| | |
| ===getReportViewDisplayedFields()===
| |
| This protected method is inherited from [[Class: I2CE_CustomReport_Display#getReportViewDisplayedFields() | I2CE_CustomReport_Display->getReportViewDisplayedFields()]]
| |
| | |
| ===getReportViewsFactory()===
| |
| This protected method is inherited from [[Class: I2CE_CustomReport_Display#getReportViewsFactory() | I2CE_CustomReport_Display->getReportViewsFactory()]]
| |
| | |
| ===getResults()===
| |
| This protected method is inherited from [[Class: I2CE_CustomReport_Display#getResults() | I2CE_CustomReport_Display->getResults()]]
| |
| | |
| ===getSwissReport()===
| |
| This protected method is inherited from [[Class: I2CE_CustomReport_Display#getSwissReport() | I2CE_CustomReport_Display->getSwissReport()]]
| |
| | |
| ===getSwissReportFunction()===
| |
| This protected method is inherited from [[Class: I2CE_CustomReport_Display#getSwissReportFunction() | I2CE_CustomReport_Display->getSwissReportFunction()]]
| |
| | |
| ===getSwissReportView()===
| |
| This protected method is inherited from [[Class: I2CE_CustomReport_Display#getSwissReportView() | I2CE_CustomReport_Display->getSwissReportView()]]
| |
| | |
| ===isMapped()===
| |
| This protected method is inherited from [[Class: I2CE_CustomReport_Display#isMapped() | I2CE_CustomReport_Display->isMapped()]]
| |
| | |
| ===mapReportFormField()===
| |
| This protected method is inherited from [[Class: I2CE_CustomReport_Display#mapReportFormField() | I2CE_CustomReport_Display->mapReportFormField()]]
| |
| | |
| ===mapResults()===
| |
| This protected method is inherited from [[Class: I2CE_CustomReport_Display#mapResults() | I2CE_CustomReport_Display->mapResults()]]
| |
| | |
| ===processWhere()===
| |
| This protected method is inherited from [[Class: I2CE_CustomReport_Display#processWhere() | I2CE_CustomReport_Display->processWhere()]]
| |
| | |
| ===processWhereByField()===
| |
| This protected method is inherited from [[Class: I2CE_CustomReport_Display#processWhereByField() | I2CE_CustomReport_Display->processWhereByField()]]
| |
| | |
| ===processWhereByFunction()===
| |
| This protected method is inherited from [[Class: I2CE_CustomReport_Display#processWhereByFunction() | I2CE_CustomReport_Display->processWhereByFunction()]]
| |
| | |
| ===setupMappedValues()===
| |
| This protected method is inherited from [[Class: I2CE_CustomReport_Display#setupMappedValues() | I2CE_CustomReport_Display->setupMappedValues()]]
| |
| | |
| ===_hasMethod()===
| |
| This public method is inherited from [[Class: I2CE_Fuzzy#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
| |
| ==Inherited Variables==
| |
| ===$formObjs===
| |
| Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$formObjs | I2CE_CustomReport_Display->$formObjs]]
| |
| | |
| ===$mappedFields===
| |
| Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$mappedFields | I2CE_CustomReport_Display->$mappedFields]]
| |
| | |
| ===$formMaps===
| |
| Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$formMaps | I2CE_CustomReport_Display->$formMaps]]
| |
| | |
| ===$fieldMaps===
| |
| Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$fieldMaps | I2CE_CustomReport_Display->$fieldMaps]]
| |
| | |
| ===$mappedValues===
| |
| Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$mappedValues | I2CE_CustomReport_Display->$mappedValues]]
| |
| | |
| ===$display===
| |
| Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$display | I2CE_CustomReport_Display->$display]]
| |
| | |
| ===$reportObj===
| |
| Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$reportObj | I2CE_CustomReport_Display->$reportObj]]
| |
| | |
| ===$defaultOptions===
| |
| Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$defaultOptions | I2CE_CustomReport_Display->$defaultOptions]]
| |
| | |
| ===$view===
| |
| Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$view | I2CE_CustomReport_Display->$view]]
| |
| | |
| ===$page===
| |
| Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$page | I2CE_CustomReport_Display->$page]]
| |
| | |
| ===$template===
| |
| Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$template | I2CE_CustomReport_Display->$template]]
| |
| | |
| ===$displayConfig===
| |
| Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$displayConfig | I2CE_CustomReport_Display->$displayConfig]]
| |
| | |
| ===$config===
| |
| Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$config | I2CE_CustomReport_Display->$config]]
| |
| | |
| ===$reportConfig===
| |
| Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$reportConfig | I2CE_CustomReport_Display->$reportConfig]]
| |
| | |
| ===$relationshipConfig===
| |
| Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$relationshipConfig | I2CE_CustomReport_Display->$relationshipConfig]]
| |
| | |
| ===$numeric===
| |
| Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$numeric | I2CE_CustomReport_Display->$numeric]]
| |
| | |
| ===$row_start===
| |
| Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$row_start | I2CE_CustomReport_Display->$row_start]]
| |
| | |
| ===$row_amount===
| |
| Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$row_amount | I2CE_CustomReport_Display->$row_amount]]
| |
| | |
| ===$reportViewsFactory===
| |
| Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$reportViewsFactory | I2CE_CustomReport_Display->$reportViewsFactory]]
| |
| ==Inherited Fuzzy Methods==
| |
| ===userMessage()===
| |
| This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
