Class: I2CE CustomReport Display Export

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

This article desrcibes the class I2CE_CustomReport_Display_Export which extends the class I2CE_CustomReport_Display It is contained in the module CustomReports_Export in the package I2CE

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

I2CE_CustomReport_Display_Export

@package I2CE

@subpackage Core

@author Carl Leitner <litlfred@ibiblio.org>

@version 2.1

@access public

Variables

$col_search

  • Type: static protected $col_search

$col_replace

  • Type: static protected $col_replace

$col_seperate

  • Type: static protected $col_seperate

$col_begin

  • Type: static protected $col_begin

$col_end

  • Type: static protected $col_end

$row_begin

  • Type: static protected $row_begin

$row_end

  • Type: static protected $row_end

$cols

  • Type: protected $cols

$style

  • Type: protected $style

Methods

canView()

  • Signature: protected function canView()

display()

Display the report

  • Signature: public function display($contentNode,$processResults,$controls)
  • Returns: boolean. true on sucess

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

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

processResultRowArray()

  • Signature: protected function processResultRowArray($row)

Parameters:

  • $row

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

Retrieved from "https://wiki.ihris.org/mediawiki/index.php?title=Class:_I2CE_CustomReport_Display_Export&oldid=5647"