Class: I2CE CustomReport Display Default: Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
Line 16: Line 16:
*Signature: protected function doHeaderRow($contentNode)
*Signature: protected function doHeaderRow($contentNode)
*Parameters:
*Parameters:
*$contentNode  
**$contentNode  
===doJumper()===
===doJumper()===
Display the results jumper
Display the results jumper
Line 22: Line 22:
*Parameters:
*Parameters:
** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $num_results <br/>Either boolean (false) if we don't have the total number of results  or an integer the number of results
** [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $num_results <br/>Either boolean (false) if we don't have the total number of results  or an integer the number of results
*$contentNode  
**$contentNode  
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]<br/>true on sucess
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]<br/>true on sucess
===processResultRow()===
===processResultRow()===

Revision as of 13:07, 17 October 2009

This article desrcibes the class I2CE_CustomReport_Display_Default.

I2CE_CustomReport_Display_Default -- the default HTML display of a report view

Variables

$formfields

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

  • Type: protected array $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)
  • 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
  • Returns: boolean
    true on sucess

processResultRow()

Process a result row.

  • 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

processResults()

Process results

  • 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

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