Class: I2CE CustomReport Display PDF (Development)

From IHRIS Wiki

Revision as of 15:26, 10 March 2010 by Litlfred (talk | contribs) (Created page with '{{otherversions|Class: I2CE_CustomReport_Display_PDF}} This article describes the class ''I2CE_CustomReport_Display_PDF'' . *Extends the class: [[Class: I2CE_CustomReport_Display…')

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

For other versions, see Class: I2CE_CustomReport_Display_PDF (versions) .

This article describes the class I2CE_CustomReport_Display_PDF .

Extends the class: I2CE_CustomReport_Display.
Location: Part of the module CustomReports_PDF in the package I2CE 4.0-dev
Source: Defined in the file modules/CustomReports/modules/PDF/lib/I2CE_CustomReport_Display_PDF.php on line 29
Author: Carl Leitner <litlfred@ibiblio.org>

I2CE_CustomReport_Display_PDF

Variables

$resultsTable

Defined in i2ce/modules/CustomReports/modules/PDF/lib/I2CE_CustomReport_Display_PDF.php on line 36
Type: protected $resultsTable

Methods

SetFont()

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

Defined in i2ce/modules/CustomReports/modules/PDF/lib/I2CE_CustomReport_Display_PDF.php on line 211
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.

Defined in i2ce/modules/CustomReports/modules/PDF/lib/I2CE_CustomReport_Display_PDF.php on line 191
Signature: protected function addFont($font,$pdf)
Parameters:
- $font
- $pdf

canView()

Defined in i2ce/modules/CustomReports/modules/PDF/lib/I2CE_CustomReport_Display_PDF.php on line 31
Signature: protected function canView()

display()

Display the report

Defined in i2ce/modules/CustomReports/modules/PDF/lib/I2CE_CustomReport_Display_PDF.php on line 45
Signature: public function display($contentNode,$processResults,$controls)
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
Returns: boolean.
true on sucess

processResultRow()

Process a result row.

Defined in i2ce/modules/CustomReports/modules/PDF/lib/I2CE_CustomReport_Display_PDF.php on line 178
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

Inherited Methods

__construct()

This public method is inherited from I2CE_CustomReport_Display->__construct()

saveDefaultView()

This public method is inherited from I2CE_CustomReport_Display->saveDefaultView()

saveDisplayOptions()

This public method is inherited from I2CE_CustomReport_Display->saveDisplayOptions()

displayMetaInfo()

This protected method is inherited from I2CE_CustomReport_Display->displayMetaInfo()

displayReportControl()

This protected method is inherited from I2CE_CustomReport_Display->displayReportControl()

displayReportControls()

This protected method is inherited from I2CE_CustomReport_Display->displayReportControls()

displayReportLimit()

This protected method is inherited from I2CE_CustomReport_Display->displayReportLimit()

displayReportLimits()

This protected method is inherited from I2CE_CustomReport_Display->displayReportLimits()

findNumericFields()

This protected method is inherited from I2CE_CustomReport_Display->findNumericFields()

getBasePage()

This protected method is inherited from I2CE_CustomReport_Display->getBasePage()

getDefaultOptions()

This protected method is inherited from I2CE_CustomReport_Display->getDefaultOptions()

getDisplayFieldsData()

This protected method is inherited from I2CE_CustomReport_Display->getDisplayFieldsData()

getFormFieldObjects()

This protected method is inherited from I2CE_CustomReport_Display->getFormFieldObjects()

getMappedValue()

This protected method is inherited from I2CE_CustomReport_Display->getMappedValue()

getReportViewDisplayedFields()

This protected method is inherited from I2CE_CustomReport_Display->getReportViewDisplayedFields()

getReportViewsFactory()

This protected method is inherited from I2CE_CustomReport_Display->getReportViewsFactory()

getResults()

This protected method is inherited from I2CE_CustomReport_Display->getResults()

getSwissReport()

This protected method is inherited from I2CE_CustomReport_Display->getSwissReport()

getSwissReportFunction()

This protected method is inherited from I2CE_CustomReport_Display->getSwissReportFunction()

getSwissReportView()

This protected method is inherited from I2CE_CustomReport_Display->getSwissReportView()

isMapped()

This protected method is inherited from I2CE_CustomReport_Display->isMapped()

mapReportFormField()

This protected method is inherited from I2CE_CustomReport_Display->mapReportFormField()

mapResults()

This protected method is inherited from I2CE_CustomReport_Display->mapResults()

processResults()

This protected method is inherited from I2CE_CustomReport_Display->processResults()

processWhere()

This protected method is inherited from I2CE_CustomReport_Display->processWhere()

processWhereByField()

This protected method is inherited from I2CE_CustomReport_Display->processWhereByField()

processWhereByFunction()

This protected method is inherited from I2CE_CustomReport_Display->processWhereByFunction()

setupMappedValues()

This protected method is inherited from I2CE_CustomReport_Display->setupMappedValues()

_hasMethod()

This public method is inherited from I2CE_Fuzzy->_hasMethod()

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_(Development)&oldid=14023"

Class Documentation (Development)