Class: I2CE CustomReport Display ODT (4.1.12)

For other versions, see Class: I2CE_CustomReport_Display_ODT (versions) .

This article describes the class I2CE_CustomReport_Display_ODT .

• Extends the class: I2CE_CustomReport_Display.
• Location: Part of the module CustomReports-PrintedReportsODT in the package I2CE 4.1.12-release
• Source: Defined in the file modules/CustomReports/modules/PrintedReportsODT/lib/I2CE_CustomReport_Display_ODT.php on line 30
• Author: Luke Duncan <lduncan@intrahealth.org>
• Since: 4.1

I2CE_CustomReport_Display_PDF

Variables

$charset

The charset for this display

• Defined in i2ce/modules/CustomReports/modules/PrintedReportsODT/lib/I2CE_CustomReport_Display_ODT.php on line 36
• Type: protected $charset

$encoding

Should html encoding be done on the data?

• Defined in i2ce/modules/CustomReports/modules/PrintedReportsODT/lib/I2CE_CustomReport_Display_ODT.php on line 42
• Type: protected $encoding

$odf

The odf file object.

• Defined in i2ce/modules/CustomReports/modules/PrintedReportsODT/lib/I2CE_CustomReport_Display_ODT.php on line 48
• Type: protected I2CE_Odf $odf

$odf_row

The odf row for each report row

• Defined in i2ce/modules/CustomReports/modules/PrintedReportsODT/lib/I2CE_CustomReport_Display_ODT.php on line 54
• Type: protected Segment $odf_row

$header_vars

The header variable names and values

• Defined in i2ce/modules/CustomReports/modules/PrintedReportsODT/lib/I2CE_CustomReport_Display_ODT.php on line 60
• Type: protected array $header_vars

$image_objs

• Defined in i2ce/modules/CustomReports/modules/PrintedReportsODT/lib/I2CE_CustomReport_Display_ODT.php on line 66
• Type: protected $image_objs

$extra

• Defined in i2ce/modules/CustomReports/modules/PrintedReportsODT/lib/I2CE_CustomReport_Display_ODT.php on line 67
• Type: protected $extra

$full_keys

• Defined in i2ce/modules/CustomReports/modules/PrintedReportsODT/lib/I2CE_CustomReport_Display_ODT.php on line 68
• Type: protected $full_keys

Methods

canView()

• Defined in i2ce/modules/CustomReports/modules/PrintedReportsODT/lib/I2CE_CustomReport_Display_ODT.php on line 62
• Signature: protected function canView()

display()

Display the report

• Defined in i2ce/modules/CustomReports/modules/PrintedReportsODT/lib/I2CE_CustomReport_Display_ODT.php on line 77
• Signature: public function display($contentNode,$processResults,$controls)
• Parameters:
  • DOMNode $contentNode
    The DOM node we wish to display into
  • boolean $processResults
    Defaults to true meaning we run through the results
    • Default Value: true
  • mixed $controls
    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.
  true on sucess

displayReportControl()

Adds any controls for this display to the content node.

• Defined in i2ce/modules/CustomReports/modules/PrintedReportsODT/lib/I2CE_CustomReport_Display_ODT.php on line 432
• Signature: protected function displayReportControl($contentNode)
• Parameters:
  • DOMNode $contentNode
• Returns: boolean

getLimitVars()

• Defined in i2ce/modules/CustomReports/modules/PrintedReportsODT/lib/I2CE_CustomReport_Display_ODT.php on line 258
• Signature: protected function getLimitVars()

processResultRow()

Process a result row.

• Defined in i2ce/modules/CustomReports/modules/PrintedReportsODT/lib/I2CE_CustomReport_Display_ODT.php on line 359
• 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

Inherited Methods

__construct()

This public method is inherited from I2CE_CustomReport_Display->__construct()

getReportLimitsDescription()

This public method is inherited from I2CE_CustomReport_Display->getReportLimitsDescription()

saveDefaultView()

This public method is inherited from I2CE_CustomReport_Display->saveDefaultView()

saveDisplayOptions()

This public method is inherited from I2CE_CustomReport_Display->saveDisplayOptions()

unsetPaging()

This public method is inherited from I2CE_CustomReport_Display->unsetPaging()

_displayReportFormLimit()

This protected method is inherited from I2CE_CustomReport_Display->_displayReportFormLimit()

_displayReportFunctionLimit()

This protected method is inherited from I2CE_CustomReport_Display->_displayReportFunctionLimit()

_displayReportInternalLimit()

This protected method is inherited from I2CE_CustomReport_Display->_displayReportInternalLimit()

_displayReportLimits()

This protected method is inherited from I2CE_CustomReport_Display->_displayReportLimits()

_getMergedReportData()

This protected method is inherited from I2CE_CustomReport_Display->_getMergedReportData()

_getPivots()

This protected method is inherited from I2CE_CustomReport_Display->_getPivots()

_getReportViewDisplayedFieldsWalker()

This protected method is inherited from I2CE_CustomReport_Display->_getReportViewDisplayedFieldsWalker()

displayMetaInfo()

This protected method is inherited from I2CE_CustomReport_Display->displayMetaInfo()

displayReportControls()

This protected method is inherited from I2CE_CustomReport_Display->displayReportControls()

displayReportLimit()

This protected method is inherited from I2CE_CustomReport_Display->displayReportLimit()

displayReportLimits()

This protected method is inherited from I2CE_CustomReport_Display->displayReportLimits()

findNumericFields()

This protected method is inherited from I2CE_CustomReport_Display->findNumericFields()

getBasePage()

This protected method is inherited from I2CE_CustomReport_Display->getBasePage()

getDefaultOptions()

This protected method is inherited from I2CE_CustomReport_Display->getDefaultOptions()

getDisplayFieldsData()

This protected method is inherited from I2CE_CustomReport_Display->getDisplayFieldsData()

getFormFieldObjects()

This protected method is inherited from I2CE_CustomReport_Display->getFormFieldObjects()

getMappedValue()

This protected method is inherited from I2CE_CustomReport_Display->getMappedValue()

getMergedReportJoins()

This protected method is inherited from I2CE_CustomReport_Display->getMergedReportJoins()

getModuleLimits()

This protected method is inherited from I2CE_CustomReport_Display->getModuleLimits()

getPivots()

This protected method is inherited from I2CE_CustomReport_Display->getPivots()

getReportPrefix()

This protected method is inherited from I2CE_CustomReport_Display->getReportPrefix()

getReportViewDisplayedFields()

This protected method is inherited from I2CE_CustomReport_Display->getReportViewDisplayedFields()

getReportViewsFactory()

This protected method is inherited from I2CE_CustomReport_Display->getReportViewsFactory()

getResults()

This protected method is inherited from I2CE_CustomReport_Display->getResults()

getSwissReport()

This protected method is inherited from I2CE_CustomReport_Display->getSwissReport()

getSwissReportFunction()

This protected method is inherited from I2CE_CustomReport_Display->getSwissReportFunction()

getSwissReportInternal()

This protected method is inherited from I2CE_CustomReport_Display->getSwissReportInternal()

getSwissReportView()

This protected method is inherited from I2CE_CustomReport_Display->getSwissReportView()

isMapped()

This protected method is inherited from I2CE_CustomReport_Display->isMapped()

mapReportFormField()

This protected method is inherited from I2CE_CustomReport_Display->mapReportFormField()

mapResults()

This protected method is inherited from I2CE_CustomReport_Display->mapResults()

mergeOn_child()

This protected method is inherited from I2CE_CustomReport_Display->mergeOn_child()

mergeOn_child_field()

This protected method is inherited from I2CE_CustomReport_Display->mergeOn_child_field()

mergeOn_parent()

This protected method is inherited from I2CE_CustomReport_Display->mergeOn_parent()

mergeOn_parent_field()

This protected method is inherited from I2CE_CustomReport_Display->mergeOn_parent_field()

processResults()

This protected method is inherited from I2CE_CustomReport_Display->processResults()

processWhere()

This protected method is inherited from I2CE_CustomReport_Display->processWhere()

processWhereByField()

This protected method is inherited from I2CE_CustomReport_Display->processWhereByField()

processWhereByFunction()

This protected method is inherited from I2CE_CustomReport_Display->processWhereByFunction()

processWhereByInternal()

This protected method is inherited from I2CE_CustomReport_Display->processWhereByInternal()

setupMappedValues()

This protected method is inherited from I2CE_CustomReport_Display->setupMappedValues()

validateSortFields()

This protected method is inherited from I2CE_CustomReport_Display->validateSortFields()

_hasMethod()

This public method is inherited from I2CE_Fuzzy->_hasMethod()

Inherited Variables

$formObjs

Theis protected variable is inherited from I2CE_CustomReport_Display->$formObjs

$mappedFields

Theis protected variable is inherited from I2CE_CustomReport_Display->$mappedFields

$formMaps

Theis protected variable is inherited from I2CE_CustomReport_Display->$formMaps

$fieldMaps

Theis protected variable is inherited from I2CE_CustomReport_Display->$fieldMaps

$mappedValues

Theis protected variable is inherited from I2CE_CustomReport_Display->$mappedValues

$display

Theis protected variable is inherited from I2CE_CustomReport_Display->$display

$reportObj

Theis protected variable is inherited from I2CE_CustomReport_Display->$reportObj

$limitDescText

Theis protected variable is inherited from I2CE_CustomReport_Display->$limitDescText

$limitModules

Theis protected variable is inherited from I2CE_CustomReport_Display->$limitModules

$defaultOptions

Theis protected variable is inherited from I2CE_CustomReport_Display->$defaultOptions

$view

Theis protected variable is inherited from I2CE_CustomReport_Display->$view

$page

Theis protected variable is inherited from I2CE_CustomReport_Display->$page

$template

Theis protected variable is inherited from I2CE_CustomReport_Display->$template

$displayConfig

Theis protected variable is inherited from I2CE_CustomReport_Display->$displayConfig

$config

Theis protected variable is inherited from I2CE_CustomReport_Display->$config

$reportConfig

Theis protected variable is inherited from I2CE_CustomReport_Display->$reportConfig

$relationshipConfig

Theis protected variable is inherited from I2CE_CustomReport_Display->$relationshipConfig

$numeric

Theis protected variable is inherited from I2CE_CustomReport_Display->$numeric

$seen_merges

Theis protected variable is inherited from I2CE_CustomReport_Display->$seen_merges

$row_start

Theis protected variable is inherited from I2CE_CustomReport_Display->$row_start

$row_amount

Theis protected variable is inherited from I2CE_CustomReport_Display->$row_amount

$relationships

Theis protected variable is inherited from I2CE_CustomReport_Display->$relationships

$reportViewsFactory

Theis protected variable is inherited from I2CE_CustomReport_Display->$reportViewsFactory

$displayed_limits

Theis protected variable is inherited from I2CE_CustomReport_Display->$displayed_limits

$displayedFields

Theis protected variable is inherited from I2CE_CustomReport_Display->$displayedFields

Inherited Fuzzy Methods

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()