Class: I2CE CustomReport Display PDF: Difference between revisions

From IHRIS Wiki
(Created page with 'This article desrcibes the class '''I2CE_CustomReport_Display_PDF'''which extends the class I2CE_CustomReport_Display It is contained in th…')
 
No edit summary
Line 47: Line 47:
**Default Value: null
**Default Value: null
==Inherited Variables==
==Inherited Variables==
===$$formObjs===
===$formObjs===
Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$$formObjs | I2CE_CustomReport_Display->$$formObjs]]
Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$formObjs | I2CE_CustomReport_Display->$formObjs]]
===$$mappedFields===
===$mappedFields===
Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$$mappedFields | I2CE_CustomReport_Display->$$mappedFields]]
Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$mappedFields | I2CE_CustomReport_Display->$mappedFields]]
===$$formMaps===
===$formMaps===
Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$$formMaps | I2CE_CustomReport_Display->$$formMaps]]
Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$formMaps | I2CE_CustomReport_Display->$formMaps]]
===$$fieldMaps===
===$fieldMaps===
Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$$fieldMaps | I2CE_CustomReport_Display->$$fieldMaps]]
Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$fieldMaps | I2CE_CustomReport_Display->$fieldMaps]]
===$$mappedValues===
===$mappedValues===
Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$$mappedValues | I2CE_CustomReport_Display->$$mappedValues]]
Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$mappedValues | I2CE_CustomReport_Display->$mappedValues]]
===$$display===
===$display===
Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$$display | I2CE_CustomReport_Display->$$display]]
Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$display | I2CE_CustomReport_Display->$display]]
===$$reportObj===
===$reportObj===
Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$$reportObj | I2CE_CustomReport_Display->$$reportObj]]
Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$reportObj | I2CE_CustomReport_Display->$reportObj]]
===$$defaultOptions===
===$defaultOptions===
Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$$defaultOptions | I2CE_CustomReport_Display->$$defaultOptions]]
Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$defaultOptions | I2CE_CustomReport_Display->$defaultOptions]]
===$$view===
===$view===
Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$$view | I2CE_CustomReport_Display->$$view]]
Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$view | I2CE_CustomReport_Display->$view]]
===$$page===
===$page===
Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$$page | I2CE_CustomReport_Display->$$page]]
Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$page | I2CE_CustomReport_Display->$page]]
===$$template===
===$template===
Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$$template | I2CE_CustomReport_Display->$$template]]
Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$template | I2CE_CustomReport_Display->$template]]
===$$displayConfig===
===$displayConfig===
Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$$displayConfig | I2CE_CustomReport_Display->$$displayConfig]]
Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$displayConfig | I2CE_CustomReport_Display->$displayConfig]]
===$$config===
===$config===
Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$$config | I2CE_CustomReport_Display->$$config]]
Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$config | I2CE_CustomReport_Display->$config]]
===$$reportConfig===
===$reportConfig===
Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$$reportConfig | I2CE_CustomReport_Display->$$reportConfig]]
Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$reportConfig | I2CE_CustomReport_Display->$reportConfig]]
===$$relationshipConfig===
===$relationshipConfig===
Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$$relationshipConfig | I2CE_CustomReport_Display->$$relationshipConfig]]
Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$relationshipConfig | I2CE_CustomReport_Display->$relationshipConfig]]
===$$numeric===
===$numeric===
Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$$numeric | I2CE_CustomReport_Display->$$numeric]]
Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$numeric | I2CE_CustomReport_Display->$numeric]]
===$$row_start===
===$row_start===
Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$$row_start | I2CE_CustomReport_Display->$$row_start]]
Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$row_start | I2CE_CustomReport_Display->$row_start]]
===$$row_amount===
===$row_amount===
Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$$row_amount | I2CE_CustomReport_Display->$$row_amount]]
Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$row_amount | I2CE_CustomReport_Display->$row_amount]]
===$$reportViewsFactory===
===$reportViewsFactory===
Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$$reportViewsFactory | I2CE_CustomReport_Display->$$reportViewsFactory]]
Theis protected variable is inherited from [[Class: I2CE_CustomReport_Display#$reportViewsFactory | I2CE_CustomReport_Display->$reportViewsFactory]]
==Inherited Fuzzy Methods==
==Inherited Fuzzy Methods==
===userMessage()===
===userMessage()===

Revision as of 16:14, 16 October 2009

This article desrcibes the class I2CE_CustomReport_Display_PDFwhich extends the class I2CE_CustomReport_Display It is contained in the module CustomReports_PDF in the package I2CE The class is defined in the file: modules/CustomReports/modules/PDF/lib/I2CE_CustomReport_Display_PDF.php I2CE_CustomReport_Display_PDF @package I2CE @subpackage Core @author Carl Leitner <litlfred@ibiblio.org> @version 2.1 @access public

Variables

$resultsTable

  • Type: protected $resultsTable

Methods

SetFont()

sets the font... ideally should move this to I2CE_PDF, but it is a mess there.

  • Signature: protected function SetFont($font,$pdf)

Parameters:

  • $font
  • $pdf

addFont()

adds the font so we can use it... ideally should move this to I2CE_PDF, but it is a mess there.

  • Signature: protected function addFont($font,$pdf)

Parameters:

  • $font
  • $pdf

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

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