|
|
| (22 intermediate revisions by one other user not shown) |
| Line 1: |
Line 1: |
| This article desrcibes the class ''I2CE_CustomReport_Display_PieChart''.
| | #REDIRECT [[Class: I2CE_CustomReport_Display_PieChart (4.1.12)]] |
| *Extends the class: [[Class: I2CE_CustomReport_Display | I2CE_CustomReport_Display]].
| |
| *Location: Part of the module [[iHRIS 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.0-release/annotate/head:/modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php modules/CustomReports/modules/PieChart/lib/I2CE_CustomReport_Display_PieChart.php]
| |
| *Author: Carl Leitner <litlfred@ibiblio.org>
| |
| I2CE_CustomReport_Display_PDF
| |
| ==Variables==
| |
| ===$chart===
| |
| *Type: protected $chart
| |
| | |
| ===$displayedChartFields===
| |
| An array with values the name of the columns used for this display
| |
| *Type: protected y $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
| |
| *Type: protected $displayedChartFieldsIndices
| |
| | |
| ==Methods==
| |
| ===canView()===
| |
| Abstract method that each display is resposbile for implementing. Checks to see if it can display the given view.
| |
| *Signature: protected function canView()
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]
| |
| ===display()===
| |
| Display the report
| |
| *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.
| |
| *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.
| |
| *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
| |
| *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()===
| |
| *Signature: protected function makeChartStylesSane($defaultOptions)
| |
| *Parameters:
| |
| **&$defaultOptions
| |
| ===postProcessResultsMultiRow()===
| |
| *Signature: protected function postProcessResultsMultiRow()
| |
| ===postProcessResultsOneRow()===
| |
| *Signature: protected function postProcessResultsOneRow()
| |
| ===preProcessResultsMultiRow()===
| |
| *Signature: protected function preProcessResultsMultiRow()
| |
| ===preProcessResultsOneRow()===
| |
| *Signature: protected function preProcessResultsOneRow()
| |
| ===processResultRow()===
| |
| Process a result row.
| |
| *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
| |
| *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
| |
| *Signature: protected function setupFlashChart($defaultOptions)
| |
| *Parameters:
| |
| **&$defaultOptions
| |
| *Returns: boolean.<br/>True on success
| |
| ==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]]
| |
