Class: I2CE CustomReport Display Default (4.0.21)

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

This article describes the class I2CE_CustomReport_Display_Default .

• Extends the class: I2CE_CustomReport_Display.
• Child Classes:
  • I2CE_CustomReport_Display_Selector
  • I2CE_CustomReport_Display_Search
• Location: Part of the module CustomReports in the package I2CE 4.0.21-release
• Source: Defined in the file modules/CustomReports/lib/I2CE_CustomReport_Display_Default.php on line 29
• Author: Carl Leitner <litlfred@ibiblio.org>

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

• Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display_Default.php on line 72
• Type: protected array $formfields

Methods

canView()

• Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display_Default.php on line 32
• Signature: protected function canView()

doHeaderRow()

• Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display_Default.php on line 76
• Signature: protected function doHeaderRow($contentNode)
• Parameters:
  • $contentNode

doJumper()

Display the results jumper

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

getJumperQryFields()

Get the query fields for the jumper

• Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display_Default.php on line 275
• Signature: protected function getJumperQryFields()
• Returns: array

processResultRow()

Process a result row.

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

• Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display_Default.php on line 44
• Signature: protected function processResults($results_data,$contentNode)
• Parameters:
  • array $results_data
    an array of results. indices are 'results' 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

Inherited Methods

__construct()

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

display()

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

saveDefaultView()

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

saveDisplayOptions()

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

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

getPivots()

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

getReportLimitsDescription()

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

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

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

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

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

$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

Inherited Fuzzy Methods

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()