Class: I2CE CustomReport Display

This article describes the abstract class I2CE_CustomReport_Display.

• Extends the class: I2CE_Fuzzy.
• Child Classes:
  • I2CE_CustomReport_Display_Default
  • I2CE_CustomReport_Display_Export
  • I2CE_CustomReport_Display_PDF
  • I2CE_CustomReport_Display_PieChart
• Location: Part of the module CustomReports in the package I2CE
• 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

$defaultOptions

The options for this display

• Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 128
• Type: protected $defaultOptions

$view

the view we are displaying

• Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 133
• Type: protected string $view

$page

The page we are displaying on

• Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 138
• Type: protected I2CE_Page $page

$template

• Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 142
• 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 149
• 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 155
• 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 160
• 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 166
• 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 182
• Type: protected array $numeric

$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 422
• 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 427
• Type: protected procted $row_amount

$reportViewsFactory

• Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 938
• Type: protected $reportViewsFactory

$displayedFields

• Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 1325
• Type: private $displayedFields

Methods

__construct()

The constuctor

• Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 76
• Signature: public function __construct($page,$view)
• Parameters:
  • I2CE_Page $page
  • string $view @throws Excecption on error

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 173
• Signature: abstract protected function canView()
• Returns: boolean

display()

Display the report

• Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 1162
• 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
• Returns: boolean.
  true on sucess

displayMetaInfo()

• Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 1258
• 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 903
• 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 843
• 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 1111
• 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 1004
• 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 190
• Signature: protected function findNumericFields($disabled)
• Parameters:
  • $disabled
    • Default Value: false
• 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 889
• 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 789
• Signature: protected function getDefaultOptions($get,$options)
• Parameters:
  • array $get
  • array $options
    Default to the empty array. The options that we want to be already set before we start goinng through
    • Default Value: array()
• 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 1333
• 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 607
• Signature: protected function getFormFieldObjects($reportformfield,$isReportForm)
• Parameters:
  • string $reportformfield
    of the re[prt form "$form" "$form+$field" or "$form+$field+$aggregate" @parmam boolean $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
• 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 451
• 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
• Returns: string
  the origina value of on failure, the mapped value on success

getReportViewDisplayedFields()

Returns an array in (default display order) with keys reportformfields and values an array with indices 'header', 'link' The value of 'header' is the display header for this field The value of 'link' is false if there is no linked page associtated to this field or a string if there is. @param Mixed $all_aggerates Defaults to false. If true we include all information about aggregate and non-agregate versions of the fields. otherwise it can be an array of aggregate information that we want

• Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 1386
• Signature: protected function getReportViewDisplayedFields($getDisabled,$all_aggregates)
• Parameters:
  • boolean $getDisabled
    Defaults to false;
    • Default Value: false
  • $all_aggregates
    • Default Value: false
• Returns: array;

getReportViewsFactory()

• Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 939
• Signature: protected function getReportViewsFactory()

getResults()

@param array $limits an nested array defining limiting values for particular fields. Defaults to the empty array.

• Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 232
• Signature: protected function getResults()
• 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 977
• Signature: protected function getSwissReport()

getSwissReportFunction()

• Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 986
• Signature: protected function getSwissReportFunction($func)
• Parameters:
  • $func

getSwissReportView()

• Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 969
• 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 547
• Signature: protected function isMapped($reportformfield)
• Parameters:
  • string $reportformfield
    of the form "$reportform+$fiedld(+$aggregate)"

mapReportFormField()

Sets the maps

• Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 568
• Signature: protected function mapReportFormField($reportformfield)
• Parameters:
  • string $reportformfield

mapResults()

Maps any mapped fields in a results.

• Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 434
• Signature: protected function mapResults($result)
• Parameters:
  • array $result
    A an array with inicies of the form "$reportform+$field(+$aggregate)" with unmapped value
• Returns: array
  the mapped results

processResultRow()

Process a result row.

• Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 1253
• 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
• Returns: boolean.
  True on success

processResults()

Process results

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

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 648
• Signature: protected function processWhere($limitValues)
• Parameters:
  • $limitValues
• Returns: string

processWhereByField()

• Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 695
• Signature: protected function processWhereByField($form,$field,$formObj,$limitStyles)
• Parameters:
  • string $form
    the (report) form
  • string $field
    the field param I2CE_Form $formObj the instantiation of the form that the report form references
  • $formObj
  • array $limitStyles
    the limit values for this formfield indexed by limit type

processWhereByFunction()

• Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 733
• Signature: protected function processWhereByFunction($function,$limitStyles)
• Parameters:
  • string $function
  • array $limitStyles
    the limit values for this formfield indexed by limit type

saveDefaultView()

• Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 1129
• Signature: public function saveDefaultView()

saveDisplayOptions()

• Defined in i2ce/modules/CustomReports/lib/I2CE_CustomReport_Display.php on line 1144
• 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 510
• Signature: protected function setupMappedValues($reportformfield,$isReportForm)
• Parameters:
  • string $reportformfield
  • $isReportForm
    • Default Value: true

Inherited Methods

_hasMethod()

This public method is inherited from I2CE_Fuzzy->_hasMethod()

Inherited Fuzzy Methods

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()