|
|
(24 intermediate revisions by one other user not shown) |
Line 1: |
Line 1: |
| This article desrcibes the class '''I2CE_CustomReport_Display_PDF'''.
| | #REDIRECT [[Class: I2CE_CustomReport_Display_PDF (4.1.12)]] |
| *Extends the class: [[Class: I2CE_CustomReport_Display | I2CE_CustomReport_Display]].
| |
| *Location: Part of the module [[iHRIS Module List#CustomReports_PDF|CustomReports_PDF]] 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/PDF/lib/I2CE_CustomReport_Display_PDF.php modules/CustomReports/modules/PDF/lib/I2CE_CustomReport_Display_PDF.php]
| |
| | |
| *Author: Carl Leitner <litlfred@ibiblio.org>
| |
| I2CE_CustomReport_Display_PDF
| |
| ==Variables==
| |
| ===$resultsTable===
| |
| *Type: protected $resultsTable
| |
| | |
| ==Methods==
| |
| ===SetFont()===
| |
| sets the font... ideally should move this to I2CE_PDF, but it is a mess there.
| |
| *Signature: protected function SetFont($font,$pdf)
| |
| Parameters:
| |
| *$font
| |
| *$pdf
| |
| ===addFont()===
| |
| adds the font so we can use it... ideally should move this to I2CE_PDF, but it is a mess there.
| |
| *Signature: protected function addFont($font,$pdf)
| |
| Parameters:
| |
| *$font
| |
| *$pdf
| |
| ===canView()===
| |
| *Signature: protected function canView()
| |
| ===display()===
| |
| Display the report
| |
| *Signature: public function display($contentNode,$processResults,$controls)
| |
| *Returns: boolean. true on sucess
| |
| 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
| |
| ===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
| |
| ==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]]
| |