Class: I2CE CustomReport Display Default

From IHRIS Wiki
Revision as of 22:24, 16 October 2009 by Litlfred (talk | contribs)

This article desrcibes the class I2CE_CustomReport_Display_Default.

It is contained in the module CustomReports in the package I2CE

The class is defined in the file: modules/CustomReports/lib/I2CE_CustomReport_Display_Default.php

I2CE_CustomReport_Display_Default -- the default HTML display of a report view @subpackage Core

  • Author: Carl Leitner <litlfred@ibiblio.org>

Variables

$formfields

The array of formfields to display for this report. Keys are the formfields

  • Type: protected y $formfields

Methods

canView()

  • Signature: protected function canView()

doHeaderRow()

  • Signature: protected function doHeaderRow($contentNode)

Parameters:

  • $contentNode

doJumper()

Display the results jumper

  • Signature: protected function doJumper($num_results,$contentNode)
  • Returns: boolean true on sucess

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

processResultRow()

Process a result row. result offset. Othwerwise, it starts counting form zero.

  • 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
  • DOMNode $contentNode
    Default to null. A node to append the result onto
    • Default Value: null

processResults()

Process results number of results. (these values may be false on failure)

  • 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
  • DOMNode $contentNode
    Default to null a node to append the results onto
    • Default Value: null

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

$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

$reportViewsFactory

Theis protected variable is inherited from I2CE_CustomReport_Display->$reportViewsFactory

Inherited Fuzzy Methods

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()