Class: I2CE CustomReport Display PDF (4.1.12)

From IHRIS Wiki
For other versions, see Class: I2CE_CustomReport_Display_PDF (versions) .


This article describes the class I2CE_CustomReport_Display_PDF .

I2CE_CustomReport_Display_PDF

Variables

$resultsTable

Methods

SetFont()

sets the font... ideally should move this to I2CE_PDF, but it is a mess there.

addFont()

adds the font so we can use it... ideally should move this to I2CE_PDF, but it is a mess there.

canView()

display()

Display the report

  • Defined in i2ce/modules/CustomReports/modules/PDF/lib/I2CE_CustomReport_Display_PDF.php on line 45
  • 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 success

getPDF()

Display the report

  • Defined in i2ce/modules/CustomReports/modules/PDF/lib/I2CE_CustomReport_Display_PDF.php on line 74
  • Signature: public function getPDF($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: mixed
    I2CE_PDF on success, boolean otherwise

processResultRow()

Process a result row.

  • Defined in i2ce/modules/CustomReports/modules/PDF/lib/I2CE_CustomReport_Display_PDF.php on line 212
  • 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()

displayReportControl()

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

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()

Retrieved from "https://wiki.ihris.org/mediawiki/index.php?title=Class:_I2CE_CustomReport_Display_PDF_(4.1.12)&oldid=54811"