Class: I2CE CustomReport Display PDF: Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
Line 1: Line 1:
This article desrcibes the class '''I2CE_CustomReport_Display_PDF''' which extends the class [[Class: I2CE_CustomReport_Display | I2CE_CustomReport_Display]]
This article desrcibes the class '''I2CE_CustomReport_Display_PDF'''.
*Extends the class: [[Class: I2CE_CustomReport_Display | I2CE_CustomReport_Display]].
It is contained in the module [[iHRIS Module List#CustomReports_PDF|CustomReports_PDF]] in the package [https://launchpad.net/i2ce I2CE]
It is contained in the module [[iHRIS Module List#CustomReports_PDF|CustomReports_PDF]] in the package [https://launchpad.net/i2ce I2CE]


Line 31: Line 32:
*Returns: boolean. true on sucess
*Returns: boolean. true on sucess
Parameters:
Parameters:
* [http://www.php.net/manual/en/class.domnode.php domnode] $contentNode<br/>The DOM node we wish to display into
* [http://www.php.net/manual/en/class.domnode.php DOMNode ] $contentNode<br/>The DOM node we wish to display into
* [http://www.php.net/manual/en/language.types.boolean.php boolean] $processResults<br/>Defaults to true meaning we run through the results
* [http://www.php.net/manual/en/language.types.boolean.php boolean ] $processResults<br/>Defaults to true meaning we run through the results
**Default Value: true
**Default Value: true
* [http://www.php.net/manual/en/language.pseudo-types.php mixed] $controls<br/>If null (default), we display all the report controsl.  If string or an array of string, we only display the indicated controls
* [http://www.php.net/manual/en/language.pseudo-types.php mixed ] $controls<br/>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
**Default Value: null
===processResultRow()===
===processResultRow()===
Line 41: Line 42:
*Signature: protected function processResultRow($row,$row_num,$contentNode)
*Signature: protected function processResultRow($row,$row_num,$contentNode)
Parameters:
Parameters:
* [http://www.php.net/manual/en/language.types.array.php array] $row
* [http://www.php.net/manual/en/language.types.array.php array ] $row
* [http://www.php.net/manual/en/language.types.integer.php int] $row_num<br/>The current row number when processing results.  If there was a result limit, it starts the count from the beginning of the
* [http://www.php.net/manual/en/language.types.integer.php int ] $row_num<br/>The current row number when processing results.  If there was a result limit, it starts the count from the beginning of the
* [http://www.php.net/manual/en/class.domnode.php domnode] $contentNode<br/>Default to null. A node to append the result onto
* [http://www.php.net/manual/en/class.domnode.php DOMNode ] $contentNode<br/>Default to null. A node to append the result onto
**Default Value: null
**Default Value: null
==Inherited Variables==
==Inherited Variables==

Revision as of 22:24, 16 October 2009

This article desrcibes the class I2CE_CustomReport_Display_PDF.

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 @subpackage Core

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

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

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