Class: I2CE CustomReport Display Export (4.1.12)

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

This article describes the class I2CE_CustomReport_Display_Export .

• Extends the class: I2CE_CustomReport_Display.
• Location: Part of the module CustomReports_Export in the package I2CE 4.1.12-release
• Source: Defined in the file modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 29
• Author: Carl Leitner <litlfred@ibiblio.org>

I2CE_CustomReport_Display_Export

Variables

$col_search

• Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 31
• Type: static protected $col_search

$col_replace

• Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 39
• Type: static protected $col_replace

$col_separate

• Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 46
• Type: static protected $col_separate

$col_begin

• Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 53
• Type: static protected $col_begin

$col_end

• Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 60
• Type: static protected $col_end

$row_begin

• Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 67
• Type: static protected $row_begin

$row_end

• Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 74
• Type: static protected $row_end

$file_suffix

• Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 81
• Type: static protected $file_suffix

$cols

• Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 245
• Type: protected $cols

$avail_xslt

• Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 248
• Type: protected $avail_xslt

$style

• Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 406
• Type: protected $style

$transform

• Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 407
• Type: protected $transform

$compression

• Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 408
• Type: protected $compression

Methods

canView()

• Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 183
• Signature: protected function canView()

display()

Display the report

• Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 553
• 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/Export/lib/I2CE_CustomReport_Display_Export.php on line 272
• Signature: protected function displayReportControl($contentNode)
• Parameters:
  • DOMNode $contentNode
• Returns: boolean;

generateExport()

Generate the the exported report

• Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 308
• Signature: public function generateExport()
• Returns: string

getAvailableXSLT()

• Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 250
• Signature: protected function getAvailableXSLT()

getCompression()

• Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 469
• Signature: protected function getCompression()

getContentType()

Return the content type for this file.

• Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 501
• Signature: public function getContentType($include_html)
• Parameters:
  • boolean $include_html
    • Default Value: false
• Returns: string

getFileName()

• Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 474
• Signature: public function getFileName($style,$compression)
• Parameters:
  • $style
    • Default Value: null
  • $compression
    • Default Value: null

getStyle()

• Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 410
• Signature: protected function getStyle()

getTransform()

• Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 463
• Signature: protected function getTransform()

getXMLMetaData()

• Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 203
• Signature: protected function getXMLMetaData($headers)
• Parameters:
  • $headers

processResultRow()

Process a result row.

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

processResultRowArray()

• Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 151
• Signature: protected function processResultRowArray($row)
• Parameters:
  • $row

processResultRowXML()

• Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 187
• Signature: protected function processResultRowXML($row,$row_num)
• Parameters:
  • $row
  • $row_num

processResults()

Process results

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

setStyle()

• Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 459
• Signature: public function setStyle($style)
• Parameters:
  • $style

setTransform()

• Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 455
• Signature: public function setTransform($transform)
• Parameters:
  • $transform

transformsToHTML()

• Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 491
• Signature: protected function transformsToHTML()

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

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