Class: I2CE CustomReport Display (4.1.7)
This article describes the abstract class I2CE_CustomReport_Display .
- Extends the class: I2CE_Fuzzy.
- Child Classes:
- Location: Part of the module CustomReports in the package I2CE 4.1.7-release
- Source: Defined in the file modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 29
- Author: Carl Leitner <litlfred@ibiblio.org>
I2CE_CustomReport_Display
Variables
$formObjs
an array indexed by forms
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 35
- Type: protected array $formObjs
$mappedFields
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 41
- Type: protected $mappedFields
$formMaps
An array where keys are of the "$reportform(+field(+$aggregate))" and the values are the corresponding "$form+$field" (that is the real form for the later) @var protected array $maps
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 47
- Type: protected $formMaps
$fieldMaps
An array where keys are of the "$reportform(+field(+$aggregate))" and the values are the corresponding "$form+$field" (that is the real form for the later)
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 52
- Type: protected array $fieldMaps
$mappedValues
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 57
- Type: protected $mappedValues
$display
The shortname for the display. E.g. 'Default'
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 63
- Type: protected string $display
$reportObj
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 68
- Type: protected I2CE_CustomReport $reportObj
$limitDescText
The list of limits for this display.
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 73
- Type: protected array $limitDescText
$limitModules
The cache of module limits with description.
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 78
- Type: protected array $limitModules
$defaultOptions
The options for this display
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 138
- Type: protected $defaultOptions
$view
the view we are displaying
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 143
- Type: protected string $view
$page
The page we are displaying on
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 148
- Type: protected I2CE_Page $page
$template
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 152
- Type: protected I2CE_TemplateMeister $template
$displayConfig
The magic data node which holds the information about the display that is being used
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 159
- Type: protected I2CE_MagicDataNode $displayConfig
$config
The magic data node which holds the information about this view
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 165
- Type: protected I2CE_MagicDataNode $config
$reportConfig
The magic data node which holds the information about the report this view referes to
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 170
- Type: protected I2CE_MagicDataNode $reportConfig
$relationshipConfig
The magic data node which holds the information about the relationship this view refers to
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 176
- Type: protected I2CE_MagicDataNode $relationshipConfig
$numeric
array with keys the 'reportformfields' and values the data associated to it. these fields are those we assume have a numeric representation
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 192
- Type: protected array $numeric
$seen_merges
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 596
- Type: protected $seen_merges
$row_start
The starting row (if any) for limiting the results. If not used, it is false mixed $row_start
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 778
- Type: protected procted $row_start
$row_amount
The number of rows (if any) for limiting the results. If not used, it is false mixed $row_amount
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 783
- Type: protected procted $row_amount
$relationships
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 970
- Type: protected $relationships
$reportViewsFactory
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 1555
- Type: protected $reportViewsFactory
$displayed_limits
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 1775
- Type: protected $displayed_limits
$displayedFields
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 2468
- Type: protected $displayedFields
Methods
__construct()
The constuctor
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 86
- Signature: public function __construct($page,$view)
- Parameters:
_displayReportFormLimit()
Displays any report limits in the content node
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 1780
- Signature: protected function _displayReportFormLimit($reportform,$field,$limit,$contentNode,$rv_config,$reportConfig,$limitValues,$excludes,$merge)
- Parameters:
- $reportform
- $field
- $limit
- DOMNode $contentNode
- $rv_config
- $reportConfig
- $limitValues
- $excludes
- $merge
- Default Value:
_displayReportFunctionLimit()
Displays any report limits in the content node
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 1834
- Signature: protected function _displayReportFunctionLimit($function,$limit,$contentNode,$rv_config,$reportConfig,$limitValues,$excludes,$merge)
- Parameters:
- $function
- $limit
- DOMNode $contentNode
- $rv_config
- $reportConfig
- $limitValues
- $excludes
- $merge
- Default Value:
_displayReportInternalLimit()
Displays any report limits for internals in the content node
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 1880
- Signature: protected function _displayReportInternalLimit($internal,$limit,$contentNode,$rv_config,$reportConfig,$limitValues,$excludes)
- Parameters:
- $internal
- $limit
- DOMNode $contentNode
- $rv_config
- $reportConfig
- $limitValues
- $excludes
_displayReportLimits()
Displays any report limits in the content node
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 1927
- Signature: protected function _displayReportLimits($contentNode,$rv_config,$report,$limitValues,$excludes,$merge)
- Parameters:
- DOMNode $contentNode
- $rv_config
- $report
- $limitValues
- $excludes
- $merge
- Default Value:
_getMergedReportData()
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 604
- Signature: protected function _getMergedReportData($config,$joins,$merge_field,$merge_ref)
- Parameters:
- $config
- &$joins
- $merge_field
- Default Value: false
- $merge_ref
- Default Value: 'primary_table'
_getPivots()
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 2367
- Signature: protected function _getPivots($config,$pivots,$pivotable_views,$reportConfig,$merge)
- Parameters:
- $config
- &$pivots
- $pivotable_views
- $reportConfig
- Default Value: null
- $merge
- Default Value:
_getReportViewDisplayedFieldsWalker()
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 2535
- Signature: protected function _getReportViewDisplayedFieldsWalker($getDisabled,$all_aggregates,$baseConfig,$field_list,$parent_report,$parent_ref)
- Parameters:
- $getDisabled
- $all_aggregates
- $baseConfig
- &$field_list
- $parent_report
- $parent_ref
canView()
Abstract method that each display is resposbile for implementing. Checks to see if it can display the given view.
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 183
- Signature: abstract protected function canView()
- Returns: boolean
display()
Display the report
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 2075
- Signature: public function display($contentNode,$processResults,$controls)
- Parameters:
- DOMNode $contentNode
The DOM node we wish to display into. If null, we do not do any of the DOM processing stuff, do not call the report display controls, limits etc. It will however still call processResults with a DOMNode of null - boolean $processResults
Defaults to true meaning we run through the results. If false, we do not process 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
displayMetaInfo()
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 2173
- Signature: protected function displayMetaInfo($contentNode)
- Parameters:
- $contentNode
displayReportControl()
Adds any controls for this display to the content node
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 1518
- Signature: protected function displayReportControl($contentNode)
- Parameters:
- DOMNode $contentNode
displayReportControls()
Adds any report display controls that can be added for this view. @param DOMNode $conentNode
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 1443
- Signature: protected function displayReportControls($contentNode,$controls)
- Parameters:
- $contentNode
- 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
displayReportLimit()
Adds the report limit node to its content node @param DOMNode $limitnode
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 2017
- Signature: protected function displayReportLimit($contentNode,$limitNode,$limitConfig)
- Parameters:
- DOMNode $contentNode
- $limitNode
- I2CE_MagicDataNode $limitConfig
displayReportLimits()
Displays any report limits in the content node
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 1753
- Signature: protected function displayReportLimits($contentNode)
- Parameters:
- DOMNode $contentNode
findNumericFields()
Find the numeric fields. Returns it (and stores in in the variable $this->numeric)
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 207
- Signature: protected function findNumericFields($disabled)
- Parameters:
- $disabled
- Default Value: false
- $disabled
- Returns: @array.
Keys are report for fields and values are the data associate defined in getDisplayedFields()
getBasePage()
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 1504
- Signature: protected function getBasePage()
getDefaultOptions()
returns an array of the default display options. Default options are read and overriddenb in the following order: /modules/CustomReports/displays/$display/display_options /modules/CustomReports/relationships/display_options/$display /modules/CustomReports/reports/display_options/$display /modules/CustomReports/reportViews/$view/display_options/$display Finally any options that have a key in $get are replaced by that value
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 1387
- Signature: protected function getDefaultOptions($get,$options)
- Parameters:
- Returns: mixed
array or false on failure
getDisplayFieldsData()
Gets the data about the fields we are going to display.
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 2476
- Signature: protected function getDisplayFieldsData()
getFormFieldObjects()
Get the form and field objects associated to a formfield string.
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 1040
- Signature: protected function getFormFieldObjects($reportformfield,$isReportForm)
- Parameters:
- string $reportformfield
of the re[prt form "$form" "$form+$field" or "$form+$field+$aggregate" @parmam string $isReportForm Defaults to true. If true we a sending a report form field If false, we are working with a form field. - $isReportForm
- Default Value: true
- string $reportformfield
- Returns: array.
Index 0 is an I2CE_Form (on success, false on failure), Index 1 is an I2CE_FormField on succces, false on failure
getMappedValue()
Gets the mapped value for a report form field.
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 807
- Signature: protected function getMappedValue($reportformfield,$value,$isReportForm)
- Parameters:
- string $reportformfield
or a report form field or a form field of the form "$reportform+$field" or "$reportform+$field+$aggreate" or "$form+field" @param value @parmam boolean $isReportForm Defaults to true. If true we a sending a report form field If false, we are working with a form field. - $value
- $isReportForm
- Default Value: true
- string $reportformfield
- Returns: string
the origina value of on failure, the mapped value on success
getMergedReportJoins()
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 597
- Signature: protected function getMergedReportJoins()
getModuleLimits()
Setup and return the module limits details.
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 1088
- Signature: protected function getModuleLimits($report,$display)
- Parameters:
- Returns: array
getPivots()
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 2248
- Signature: protected function getPivots()
getReportLimitsDescription()
Return a string representation of the limits for this report.
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 1658
- Signature: public function getReportLimitsDescription()
- Returns: string
getReportPrefix()
Get the report results prefix for the DOM.
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 199
- Signature: protected function getReportPrefix()
- Returns: strng
getReportViewDisplayedFields()
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 2528
- Signature: protected function getReportViewDisplayedFields($getDisabled,$all_aggregates)
- Parameters:
- $getDisabled
- Default Value: false
- $all_aggregates
- Default Value: false
- $getDisabled
getReportViewsFactory()
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 1556
- Signature: protected function getReportViewsFactory()
getResults()
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 313
- Signature: protected function getResults($check_restart)
- Parameters:
- boolean $check_restart
defaults to true in which case if the results are paginated and the offeset is more than the number of results, we restart it setting the page to 1- Default Value: true
- boolean $check_restart
- Returns: mixed
false on failure on succes an array. at index 'results' and MDB2 buffered result object at index 'num_results' the number of results that would be found without the limit
getSwissReport()
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 1594
- Signature: protected function getSwissReport($report)
- Parameters:
- $report
getSwissReportFunction()
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 1609
- Signature: protected function getSwissReportFunction($func,$report)
- Parameters:
- $func
- $report
getSwissReportInternal()
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 1631
- Signature: protected function getSwissReportInternal($internal,$report)
- Parameters:
- $internal
- $report
getSwissReportView()
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 1586
- Signature: protected function getSwissReportView()
isMapped()
Checks to see if a form field is mapped
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 947
- Signature: protected function isMapped($reportformfield,$report)
- Parameters:
- string $reportformfield
of the form "$reportform+$fiedld(+$aggregate)" - $report
- Default Value: null
- string $reportformfield
mapReportFormField()
Sets the maps
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 976
- Signature: protected function mapReportFormField($reportformfield,$report)
- Parameters:
- string $reportformfield
- $report
- Default Value: null
mapResults()
Maps any mapped fields in a results.
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 790
- Signature: protected function mapResults($result)
- Parameters:
- array $result
A an array with inicies of the form "$reportform+$field(+$aggregate)" with unmapped value
- array $result
- Returns: array
the mapped results
mergeOn_child()
Generate SQL join statement for joining on the named parent form's id with the named child form on a given field @param string $childFormName the name of the child form in the relationship
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 758
- Signature: protected function mergeOn_child($parent_merge_ref,$parent_form,$parent_field,$merge_ref,$child_form,$joinData,$conditions)
- Parameters:
- $parent_merge_ref
- $parent_form
- $parent_field
- $merge_ref
- $child_form
- array $joinData
The array containg the join data - $conditions
- Returns: mixed.
On success, a string which is the SQL join statement. On failure, false
mergeOn_child_field()
Generate SQL join statement for joining on the named parent form's id with the named child form on a given field @param string $childFormName the name of the child form in the relationship
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 740
- Signature: protected function mergeOn_child_field($parent_merge_ref,$parent_form,$parent_field,$merge_ref,$child_form,$joinData,$conditions)
- Parameters:
- $parent_merge_ref
- $parent_form
- $parent_field
- $merge_ref
- $child_form
- array $joinData
The array containg the join data - $conditions
- Returns: mixed.
On success, a string which is the SQL join statement. On failure, false
mergeOn_parent()
Generate SQL join statement for joining on the named parent form's id with the named child form on a given field @param string $childFormName the name of the child form in the relationship
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 769
- Signature: protected function mergeOn_parent($parent_merge_ref,$parent_form,$parent_field,$merge_ref,$child_form,$joinData,$conditions)
- Parameters:
- $parent_merge_ref
- $parent_form
- $parent_field
- $merge_ref
- $child_form
- array $joinData
The array containg the join data - &$conditions
- Returns: mixed.
On success, a string which is the SQL join statement. On failure, false
mergeOn_parent_field()
Generate SQL join statement for joining on the named parent form's id with the named child form on a given field @param string $childFormName the name of the child form in the relationship
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 721
- Signature: protected function mergeOn_parent_field($parent_merge_ref,$parent_form,$parent_field,$merge_ref,$child_form,$joinData,$conditions)
- Parameters:
- $parent_merge_ref
- $parent_form
- $parent_field
- $merge_ref
- $child_form
- array $joinData
The array containg the join data - $conditions
- Returns: mixed.
On success, a string which is the SQL join statement. On failure, false
processResultRow()
Process a result row.
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 2168
- Signature: protected function processResultRow($row,$row_num,$contentNode)
- Parameters:
- Returns: boolean.
True on success
processResults()
Process results
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 2134
- Signature: protected function processResults($results_data,$contentNode)
- Parameters:
processWhere()
Process the fields to make limits based on their limiting values @param array $limits an array defining limiting values for particular fields
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 1167
- Signature: protected function processWhere($limitValues,$report)
- Parameters:
- $limitValues
- $report
- Default Value: null
- Returns: string
processWhereByField()
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 1233
- Signature: protected function processWhereByField($form,$field,$formObj,$limitStyles,$report)
- Parameters:
processWhereByFunction()
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 1277
- Signature: protected function processWhereByFunction($function,$limitStyles,$report)
- Parameters:
processWhereByInternal()
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 1326
- Signature: protected function processWhereByInternal($internal,$limitStyles,$report)
- Parameters:
saveDefaultView()
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 2040
- Signature: public function saveDefaultView()
saveDisplayOptions()
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 2055
- Signature: public function saveDisplayOptions()
setupMappedValues()
Stores the array of mapped value for a formfield in {@var $formfield} @parmam boolean $isReportForm Defaults to true. If true we a sending a report form field If false, we are working with a form field.
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 896
- Signature: protected function setupMappedValues($reportformfield,$isReportForm)
- Parameters:
- string $reportformfield
- $isReportForm
- Default Value: true
unsetPaging()
Unset the limit_paginated option since doing it in the $_GET array won't work since no value would be set. This is mainly for other objects working with reports instead of the default report display.
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 303
- Signature: public function unsetPaging()
validateSortFields()
Validates an array of fields to sort on
- Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 260
- Signature: protected function validateSortFields($sort_fields,$valid_fields)
- Parameters:
- Returns: array.
An validate array of string, the sorting fields
Inherited Methods
_hasMethod()
This public method is inherited from I2CE_Fuzzy->_hasMethod()
Inherited Fuzzy Methods
userMessage()
This method is inherited from I2CE_Fuzzy->userMessage()