|
|
| Line 1: |
Line 1: |
| This article describes the ''abstract'' class ''I2CE_CustomReport_Display''.
| | #REDIRECT [[Class: I2CE_CustomReport_Display (4.0.3)]] |
| *Extends the class: [[Class: I2CE_Fuzzy | I2CE_Fuzzy]].
| |
| *Child Classes:
| |
| ** [[Class: I2CE_CustomReport_Display_Default | I2CE_CustomReport_Display_Default]]
| |
| ** [[Class: I2CE_CustomReport_Display_Export | I2CE_CustomReport_Display_Export]]
| |
| ** [[Class: I2CE_CustomReport_Display_PDF | I2CE_CustomReport_Display_PDF]]
| |
| ** [[Class: I2CE_CustomReport_Display_PieChart | I2CE_CustomReport_Display_PieChart]]
| |
| *Location: Part of the module [[I2CE Module List#CustomReports|CustomReports]] 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/lib/I2CE_CustomReport_Display.php#L29 modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 29
| |
| *Author: Carl Leitner <litlfred@ibiblio.org>
| |
| I2CE_CustomReport_Display
| |
| ==Variables==
| |
| ===$formObjs===
| |
| an array indexed by forms
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L35 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 35
| |
| *Type: protected [http://www.php.net/manual/en/language.types.array.php array ] $formObjs
| |
| | |
| ===$mappedFields===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L41 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 41
| |
| *Type: protected $mappedFields
| |
| | |
| ===$formMaps===
| |
| An array where keys are of the "$reportform(+field(+$aggregate))" and the values are the corresponding "$form+$field" (that is the real form for the later) @var protected array $maps
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L47 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 47
| |
| *Type: protected $formMaps
| |
| | |
| ===$fieldMaps===
| |
| An array where keys are of the "$reportform(+field(+$aggregate))" and the values are the corresponding "$form+$field" (that is the real form for the later)
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L52 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 52
| |
| *Type: protected [http://www.php.net/manual/en/language.types.array.php array ] $fieldMaps
| |
| | |
| ===$mappedValues===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L57 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 57
| |
| *Type: protected $mappedValues
| |
| | |
| ===$display===
| |
| The shortname for the display. E.g. 'Default'
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L63 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 63
| |
| *Type: protected [http://www.php.net/manual/en/language.types.string.php string ] $display
| |
| | |
| ===$reportObj===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L68 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 68
| |
| *Type: protected [[Class: I2CE_CustomReport | I2CE_CustomReport]] $reportObj
| |
| | |
| ===$defaultOptions===
| |
| The options for this display
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L128 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 128
| |
| *Type: protected $defaultOptions
| |
| | |
| ===$view===
| |
| the view we are displaying
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L133 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 133
| |
| *Type: protected [http://www.php.net/manual/en/language.types.string.php string ] $view
| |
| | |
| ===$page===
| |
| The page we are displaying on
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L138 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 138
| |
| *Type: protected [[Class: I2CE_Page | I2CE_Page]] $page
| |
| | |
| ===$template===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L142 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 142
| |
| *Type: protected [[Class: I2CE_TemplateMeister | I2CE_TemplateMeister]] $template
| |
| | |
| ===$displayConfig===
| |
| The magic data node which holds the information about the display that is being used
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L149 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 149
| |
| *Type: protected [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $displayConfig
| |
| | |
| ===$config===
| |
| The magic data node which holds the information about this view
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L155 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 155
| |
| *Type: protected [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $config
| |
| | |
| ===$reportConfig===
| |
| The magic data node which holds the information about the report this view referes to
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L160 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 160
| |
| *Type: protected [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $reportConfig
| |
| | |
| ===$relationshipConfig===
| |
| The magic data node which holds the information about the relationship this view refers to
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L166 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 166
| |
| *Type: protected [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $relationshipConfig
| |
| | |
| ===$numeric===
| |
| array with keys the 'reportformfields' and values the data associated to it. these fields are those we assume have a numeric representation
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L182 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 182
| |
| *Type: protected [http://www.php.net/manual/en/language.types.array.php array ] $numeric
| |
| | |
| ===$row_start===
| |
| The starting row (if any) for limiting the results. If not used, it is false mixed $row_start
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L422 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 422
| |
| *Type: protected procted $row_start
| |
| | |
| ===$row_amount===
| |
| The number of rows (if any) for limiting the results. If not used, it is false mixed $row_amount
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L427 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 427
| |
| *Type: protected procted $row_amount
| |
| | |
| ===$reportViewsFactory===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L938 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 938
| |
| *Type: protected $reportViewsFactory
| |
| | |
| ===$displayedFields===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L1325 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 1325
| |
| *Type: private $displayedFields
| |
| | |
| ==Methods==
| |
| ===__construct()===
| |
| The constuctor
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L76 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 76
| |
| *Signature: public function __construct($page,$view)
| |
| *Parameters:
| |
| ** [[Class: I2CE_Page | I2CE_Page]] $page
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $view @throws Excecption on error
| |
| ===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/lib/I2CE_CustomReport_Display.php#L173 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 173
| |
| *Signature: abstract 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/lib/I2CE_CustomReport_Display.php#L1162 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 1162
| |
| *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. If null, we do not do any of the DOM processing stuff, do not call the report display controls, limits etc. It will however still call processResults with a DOMNode of null
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $processResults <br/>Defaults to true meaning we run through the results. If false, we do not process 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
| |
| ===displayMetaInfo()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L1258 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 1258
| |
| *Signature: protected function displayMetaInfo($contentNode)
| |
| *Parameters:
| |
| **$contentNode
| |
| ===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/lib/I2CE_CustomReport_Display.php#L903 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 903
| |
| *Signature: protected function displayReportControl($contentNode)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $contentNode
| |
| ===displayReportControls()===
| |
| Adds any report display controls that can be added for this view. @param DOMNode $conentNode
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L843 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 843
| |
| *Signature: protected function displayReportControls($contentNode,$controls)
| |
| *Parameters:
| |
| **$contentNode
| |
| ** [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: [http://www.php.net/manual/en/language.types.boolean.php boolean ]<br/>$true on success
| |
| ===displayReportLimit()===
| |
| Adds the report limit node to its content node @param DOMNode $limitnode
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L1111 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 1111
| |
| *Signature: protected function displayReportLimit($contentNode,$limitNode,$limitConfig)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $contentNode
| |
| **$limitNode
| |
| ** [[Class: I2CE_MagicDataNode | I2CE_MagicDataNode]] $limitConfig
| |
| ===displayReportLimits()===
| |
| Displays any report limits in the content node
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L1004 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 1004
| |
| *Signature: protected function displayReportLimits($contentNode)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $contentNode
| |
| ===findNumericFields()===
| |
| Find the numeric fields. Returns it (and stores in in the variable $this->numeric)
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L190 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 190
| |
| *Signature: protected function findNumericFields($disabled)
| |
| *Parameters:
| |
| **$disabled
| |
| ***Default Value: false
| |
| *Returns: @array.<br/>Keys are report for fields and values are the data associate defined in getDisplayedFields()
| |
| ===getBasePage()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L889 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 889
| |
| *Signature: protected function getBasePage()
| |
| ===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/lib/I2CE_CustomReport_Display.php#L789 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 789
| |
| *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.pseudo-types.php mixed ]<br/>array or false on failure
| |
| ===getDisplayFieldsData()===
| |
| Gets the data about the fields we are going to display.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L1333 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 1333
| |
| *Signature: protected function getDisplayFieldsData()
| |
| ===getFormFieldObjects()===
| |
| Get the form and field objects associated to a formfield string.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L607 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 607
| |
| *Signature: protected function getFormFieldObjects($reportformfield,$isReportForm)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $reportformfield <br/>of the re[prt form "$form" "$form+$field" or "$form+$field+$aggregate" @parmam boolean $isReportForm Defaults to true. If true we a sending a report form field If false, we are working with a form field.
| |
| **$isReportForm
| |
| ***Default Value: true
| |
| *Returns: array.<br/>Index 0 is an I2CE_Form (on success, false on failure), Index 1 is an I2CE_FormField on succces, false on failure
| |
| ===getMappedValue()===
| |
| Gets the mapped value for a report form field.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L451 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 451
| |
| *Signature: protected function getMappedValue($reportformfield,$value,$isReportForm)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $reportformfield <br/>or a report form field or a form field of the form "$reportform+$field" or "$reportform+$field+$aggreate" or "$form+field" @param value @parmam boolean $isReportForm Defaults to true. If true we a sending a report form field If false, we are working with a form field.
| |
| **$value
| |
| **$isReportForm
| |
| ***Default Value: true
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]<br/>the origina value of on failure, the mapped value on success
| |
| ===getReportViewDisplayedFields()===
| |
| Returns an array in (default display order) with keys reportformfields and values an array with indices 'header', 'link' The value of 'header' is the display header for this field The value of 'link' is false if there is no linked page associtated to this field or a string if there is. @param Mixed $all_aggerates Defaults to false. If true we include all information about aggregate and non-agregate versions of the fields. otherwise it can be an array of aggregate information that we want
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L1386 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 1386
| |
| *Signature: protected function getReportViewDisplayedFields($getDisabled,$all_aggregates)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.boolean.php boolean ] $getDisabled <br/>Defaults to false;
| |
| ***Default Value: false
| |
| **$all_aggregates
| |
| ***Default Value: false
| |
| *Returns: array;
| |
| ===getReportViewsFactory()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L939 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 939
| |
| *Signature: protected function getReportViewsFactory()
| |
| ===getResults()===
| |
| @param array $limits an nested array defining limiting values for particular fields. Defaults to the empty array.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L232 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 232
| |
| *Signature: protected function getResults()
| |
| *Returns: [http://www.php.net/manual/en/language.pseudo-types.php mixed ]<br/>false on failure on succes an array. at index 'results' and MDB2 buffered result object at index 'num_results' the number of results that would be found without the limit
| |
| ===getSwissReport()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L977 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 977
| |
| *Signature: protected function getSwissReport()
| |
| ===getSwissReportFunction()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L986 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 986
| |
| *Signature: protected function getSwissReportFunction($func)
| |
| *Parameters:
| |
| **$func
| |
| ===getSwissReportView()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L969 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 969
| |
| *Signature: protected function getSwissReportView()
| |
| ===isMapped()===
| |
| Checks to see if a form field is mapped
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L547 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 547
| |
| *Signature: protected function isMapped($reportformfield)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $reportformfield <br/>of the form "$reportform+$fiedld(+$aggregate)"
| |
| ===mapReportFormField()===
| |
| Sets the maps
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L568 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 568
| |
| *Signature: protected function mapReportFormField($reportformfield)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $reportformfield
| |
| ===mapResults()===
| |
| Maps any mapped fields in a results.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L434 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 434
| |
| *Signature: protected function mapResults($result)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $result <br/>A an array with inicies of the form "$reportform+$field(+$aggregate)" with unmapped value
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>the mapped results
| |
| ===processResultRow()===
| |
| Process a result row.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L1253 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 1253
| |
| *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
| |
| *Returns: boolean.<br/>True on success
| |
| ===processResults()===
| |
| Process results
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L1219 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 1219
| |
| *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
| |
| ===processWhere()===
| |
| Process the fields to make limits based on their limiting values @param array $limits an array defining limiting values for particular fields
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L648 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 648
| |
| *Signature: protected function processWhere($limitValues)
| |
| *Parameters:
| |
| **$limitValues
| |
| *Returns: [http://www.php.net/manual/en/language.types.string.php string ]
| |
| ===processWhereByField()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L695 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 695
| |
| *Signature: protected function processWhereByField($form,$field,$formObj,$limitStyles)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $form <br/>the (report) form
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $field <br/>the field param I2CE_Form $formObj the instantiation of the form that the report form references
| |
| **$formObj
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $limitStyles <br/>the limit values for this formfield indexed by limit type
| |
| ===processWhereByFunction()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L733 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 733
| |
| *Signature: protected function processWhereByFunction($function,$limitStyles)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $function
| |
| ** [http://www.php.net/manual/en/language.types.array.php array ] $limitStyles <br/>the limit values for this formfield indexed by limit type
| |
| ===saveDefaultView()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L1129 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 1129
| |
| *Signature: public function saveDefaultView()
| |
| ===saveDisplayOptions()===
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L1144 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 1144
| |
| *Signature: public function saveDisplayOptions()
| |
| ===setupMappedValues()===
| |
| Stores the array of mapped value for a formfield in {@var $formfield} @parmam boolean $isReportForm Defaults to true. If true we a sending a report form field If false, we are working with a form field.
| |
| *Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display.php#L510 i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php] on line 510
| |
| *Signature: protected function setupMappedValues($reportformfield,$isReportForm)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $reportformfield
| |
| **$isReportForm
| |
| ***Default Value: true
| |
| ==Inherited Methods==
| |
| ===_hasMethod()===
| |
| This public method is inherited from [[Class: I2CE_Fuzzy#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
| |
| ==Inherited Fuzzy Methods==
| |
| ===userMessage()===
| |
| This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
