Class: I2CE CustomReport Display Export (4.1.1)
From IHRIS Wiki
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.1-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
Contents
- 1 Variables
- 2 Methods
- 2.1 canView()
- 2.2 display()
- 2.3 displayReportControl()
- 2.4 generateExport()
- 2.5 getAvailableXSLT()
- 2.6 getCompression()
- 2.7 getFileName()
- 2.8 getStyle()
- 2.9 getTransform()
- 2.10 getXMLMetaData()
- 2.11 processResultRow()
- 2.12 processResultRowArray()
- 2.13 processResultRowXML()
- 2.14 processResults()
- 2.15 transformsToHTML()
- 3 Inherited Methods
- 3.1 __construct()
- 3.2 saveDefaultView()
- 3.3 saveDisplayOptions()
- 3.4 _displayReportLimits()
- 3.5 _getMergedReportData()
- 3.6 _getPivots()
- 3.7 _getReportViewDisplayedFieldsWalker()
- 3.8 displayMetaInfo()
- 3.9 displayReportControls()
- 3.10 displayReportLimit()
- 3.11 displayReportLimits()
- 3.12 findNumericFields()
- 3.13 getBasePage()
- 3.14 getDefaultOptions()
- 3.15 getDisplayFieldsData()
- 3.16 getFormFieldObjects()
- 3.17 getMappedValue()
- 3.18 getMergedReportJoins()
- 3.19 getPivots()
- 3.20 getReportLimitsDescription()
- 3.21 getReportViewDisplayedFields()
- 3.22 getReportViewsFactory()
- 3.23 getResults()
- 3.24 getSwissReport()
- 3.25 getSwissReportFunction()
- 3.26 getSwissReportView()
- 3.27 isMapped()
- 3.28 mapReportFormField()
- 3.29 mapResults()
- 3.30 mergeOn_child()
- 3.31 mergeOn_child_field()
- 3.32 mergeOn_parent()
- 3.33 mergeOn_parent_field()
- 3.34 processWhere()
- 3.35 processWhereByField()
- 3.36 processWhereByFunction()
- 3.37 setupMappedValues()
- 3.38 validateSortFields()
- 3.39 _hasMethod()
- 4 Inherited Variables
- 4.1 $formObjs
- 4.2 $mappedFields
- 4.3 $formMaps
- 4.4 $fieldMaps
- 4.5 $mappedValues
- 4.6 $display
- 4.7 $reportObj
- 4.8 $defaultOptions
- 4.9 $view
- 4.10 $page
- 4.11 $template
- 4.12 $displayConfig
- 4.13 $config
- 4.14 $reportConfig
- 4.15 $relationshipConfig
- 4.16 $numeric
- 4.17 $seen_merges
- 4.18 $row_start
- 4.19 $row_amount
- 4.20 $relationships
- 4.21 $reportViewsFactory
- 5 Inherited Fuzzy Methods
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 36
- Type: static protected $col_replace
$col_separate
- Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 41
- Type: static protected $col_separate
$col_begin
- Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 46
- Type: static protected $col_begin
$col_end
- Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 51
- Type: static protected $col_end
$row_begin
- Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 56
- Type: static protected $row_begin
$row_end
- Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 61
- Type: static protected $row_end
$cols
- Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 200
- Type: protected $cols
$avail_xslt
- Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 203
- Type: protected $avail_xslt
$style
- Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 352
- Type: protected $style
$transform
- Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 353
- Type: protected $transform
$compression
- Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 354
- Type: protected $compression
Methods
canView()
- Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 139
- Signature: protected function canView()
display()
Display the report
- Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 441
- 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
- DOMNode $contentNode
- 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 227
- 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 263
- Signature: public function generateExport()
- Returns: string
getAvailableXSLT()
- Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 205
- Signature: protected function getAvailableXSLT()
getCompression()
- Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 408
- Signature: protected function getCompression()
getFileName()
- Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 413
- Signature: public function getFileName($style,$compression)
- Parameters:
- $style
- Default Value: null
- $compression
- Default Value: null
- $style
getStyle()
- Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 356
- Signature: protected function getStyle()
getTransform()
- Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 402
- Signature: protected function getTransform()
getXMLMetaData()
- Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 158
- 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 110
- Signature: protected function processResultRow($row,$row_num,$contentNode)
- Parameters:
processResultRowArray()
- Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 123
- Signature: protected function processResultRowArray($row)
- Parameters:
- $row
processResultRowXML()
- Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 143
- 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 75
- Signature: protected function processResults($results_data,$contentNode)
- Parameters:
transformsToHTML()
- Defined in i2ce/modules/CustomReports/modules/Export/lib/I2CE_CustomReport_Display_Export.php on line 430
- Signature: protected function transformsToHTML()
Inherited Methods
__construct()
This public method is inherited from I2CE_CustomReport_Display->__construct()
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()
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()