|
|
| (28 intermediate revisions by one other user not shown) |
| Line 1: |
Line 1: |
| This article desrcibes the class '''I2CE_CustomReport_Display_Default''' which extends the class [[Class: I2CE_CustomReport_Display | I2CE_CustomReport_Display]]
| | #REDIRECT [[Class: I2CE_CustomReport_Display_Default (4.1.12)]] |
| It is contained in the module [[iHRIS Module List#CustomReports|CustomReports]] in the package [https://launchpad.net/i2ce I2CE]
| |
| | |
| The class is defined in the file: [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display_Default.php modules/CustomReports/lib/I2CE_CustomReport_Display_Default.php]
| |
| | |
| I2CE_CustomReport_Display_Default -- the default HTML display of a report view | |
| @subpackage Core
| |
| *Author: Carl Leitner <litlfred@ibiblio.org>
| |
| ==Variables==
| |
| ===$formfields===
| |
| The array of formfields to display for this report.
| |
| Keys are the formfields
| |
| *Type: protected y $formfields
| |
| | |
| ==Methods==
| |
| ===canView()===
| |
| *Signature: protected function canView()
| |
| ===doHeaderRow()===
| |
| *Signature: protected function doHeaderRow($contentNode)
| |
| Parameters:
| |
| *$contentNode
| |
| ===doJumper()===
| |
| Display the results jumper
| |
| *Signature: protected function doJumper($num_results,$contentNode)
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean] true on sucess
| |
| Parameters:
| |
| * [http://www.php.net/manual/en/language.pseudo-types.php mixed] $num_results<br/>Either boolean (false) if we don't have the total number of results or an integer the number of results
| |
| *$contentNode
| |
| ===processResultRow()===
| |
| Process a result row.
| |
| result offset. Othwerwise, it starts counting form zero.
| |
| *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
| |
| * [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
| |
| number of results. (these values may be false on failure)
| |
| *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
| |
| * [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
| |
| ==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]]
| |
