Class: I2CE CustomReport Display Default: Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
Line 2: Line 2:
*Extends the class: [[Class: I2CE_CustomReport_Display | I2CE_CustomReport_Display]].
*Extends the class: [[Class: I2CE_CustomReport_Display | I2CE_CustomReport_Display]].
*Parent Classses:  [[Class: I2CE_CustomReport_Display | I2CE_CustomReport_Display]] [[Class: I2CE_Fuzzy | I2CE_Fuzzy]]
*Parent Classses:  [[Class: I2CE_CustomReport_Display | I2CE_CustomReport_Display]] [[Class: I2CE_Fuzzy | I2CE_Fuzzy]]
*Location: Part of the module [[iHRIS Module List#CustomReports|CustomReports]] in the package [https://launchpad.net/i2ce I2CE]
*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.0-release/annotate/head:/modules/CustomReports/lib/I2CE_CustomReport_Display_Default.php modules/CustomReports/lib/I2CE_CustomReport_Display_Default.php]
*Source: 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]
*Author: Carl Leitner <litlfred@ibiblio.org>
*Author: Carl Leitner <litlfred@ibiblio.org>
Line 40: Line 40:
** [http://www.php.net/manual/en/class.domnode.php DOMNode ] $contentNode <br/>Default to null a node to append the results onto
** [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
***Default Value: null
==Inherited Methods==
===__construct()===
This public method is inherited from [[Class: I2CE_CustomReport_Display#__construct() | I2CE_CustomReport_Display->__construct()]]
===display()===
This public method is inherited from [[Class: I2CE_CustomReport_Display#display() | I2CE_CustomReport_Display->display()]]
===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()]]
===displayReportControl()===
This protected method is inherited from [[Class: I2CE_CustomReport_Display#displayReportControl() | I2CE_CustomReport_Display->displayReportControl()]]
===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()]]
===getDefaultOptions()===
This protected method is inherited from [[Class: I2CE_CustomReport_Display#getDefaultOptions() | I2CE_CustomReport_Display->getDefaultOptions()]]
===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]]
[[Category:Class Documentation]]

Revision as of 13:08, 19 October 2009

This article describes the class I2CE_CustomReport_Display_Default.

I2CE_CustomReport_Display_Default -- the default HTML display of a report view

Variables

$formfields

The array of formfields to display for this report. Keys are the formfields

  • Type: protected array $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)
  • Parameters:
    • mixed $num_results
      Either boolean (false) if we don't have the total number of results or an integer the number of results
    • $contentNode
  • Returns: boolean
    true on sucess

processResultRow()

Process a result row.

  • Signature: protected function processResultRow($row,$row_num,$contentNode)
  • Parameters:
    • array $row
    • int $row_num
      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.
    • DOMNode $contentNode
      Default to null. A node to append the result onto
      • Default Value: null

processResults()

Process results

  • Signature: protected function processResults($results_data,$contentNode)
  • Parameters:
    • array $results_data
      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)
    • DOMNode $contentNode
      Default to null a node to append the results onto
      • Default Value: null
Retrieved from "https://wiki.ihris.org/mediawiki/index.php?title=Class:_I2CE_CustomReport_Display_Default&oldid=9568"