Class: I2CE PageGenerateRelationshipTemplate (Development)

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

This article describes the class I2CE_PageGenerateRelationshipTemplate .

• Extends the class: I2CE_PageActionRelationship.
• Child Classes:
  • iHRIS_PageActionStudentCertificates
• Location: Part of the module formRelationships in the package I2CE 4.1-dev
• Source: Defined in the file modules/Forms/modules/FormRelationship/lib/I2CE_PageGenerateRelationshipTemplate.php on line 37
• Author: Carl Leitner <litlfred@ibiblio.org>
• Since: v4.1.3

Edit participants action for a training @copyright Copyright © 2012 IntraHealth International, Inc. The action page class for editing particpants for a training

Variables

$charset

The charset for this display

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_PageGenerateRelationshipTemplate.php on line 42
• Type: protected $charset

$encoding

Should html encoding be done on the data?

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_PageGenerateRelationshipTemplate.php on line 48
• Type: protected $encoding

$template_file

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_PageGenerateRelationshipTemplate.php on line 50
• Type: protected $template_file

$template_vars

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_PageGenerateRelationshipTemplate.php on line 51
• Type: protected $template_vars

$template_var_options

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_PageGenerateRelationshipTemplate.php on line 52
• Type: protected $template_var_options

$template_var_keys

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_PageGenerateRelationshipTemplate.php on line 53
• Type: protected $template_var_keys

Methods

action()

Perform the main actions of the page.

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_PageGenerateRelationshipTemplate.php on line 58
• Signature: protected function action()
• Returns: boolean

generateTemplate()

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_PageGenerateRelationshipTemplate.php on line 91
• Signature: protected function generateTemplate()

generateTemplate_global()

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_PageGenerateRelationshipTemplate.php on line 165
• Signature: protected function generateTemplate_global($odf)
• Parameters:
  • $odf

generateTemplate_report_row()

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_PageGenerateRelationshipTemplate.php on line 119
• Signature: protected function generateTemplate_report_row($odf)
• Parameters:
  • $odf

getFields()

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_PageGenerateRelationshipTemplate.php on line 79
• Signature: protected function getFields()

getMissingFields()

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_PageGenerateRelationshipTemplate.php on line 279
• Signature: protected function getMissingFields($required,$data)
• Parameters:
  • $required
  • $data
    • Default Value: null

getODTTemplate()

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_PageGenerateRelationshipTemplate.php on line 636
• Signature: protected function getODTTemplate()

getTemplateVariables()

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_PageGenerateRelationshipTemplate.php on line 565
• Signature: protected function getTemplateVariables()

loopData()

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_PageGenerateRelationshipTemplate.php on line 257
• Signature: protected function loopData($odf,$segment,$data)
• Parameters:
  • $odf
  • $segment
  • $data
    • Default Value: null

outputTemplate()

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_PageGenerateRelationshipTemplate.php on line 412
• Signature: protected function outputTemplate($odf,$basename,$saveOnFormObj,$fieldName,$saveFileOnDB)
• Parameters:
  • $odf
  • $basename
  • $saveOnFormObj
    • Default Value: false
  • $fieldName
    • Default Value: false
  • $saveFileOnDB
    • Default Value: false

setData()

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_PageGenerateRelationshipTemplate.php on line 365
• Signature: protected function setData($segment,$row,$formfields,$formRelationship)
• Parameters:
  • $segment
  • $row
  • $formfields
  • $formRelationship
    • Default Value: null

setHeaderVars()

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_PageGenerateRelationshipTemplate.php on line 217
• Signature: protected function setHeaderVars($segment)
• Parameters:
  • $segment

setSegmentValue()

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_PageGenerateRelationshipTemplate.php on line 536
• Signature: protected function setSegmentValue($segment,$fieldObj,$key,$value,$options)
• Parameters:
  • $segment
  • $fieldObj
  • $key
  • $value
  • $options
    • Default Value: array()

setStyleVars()

• Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_PageGenerateRelationshipTemplate.php on line 313
• Signature: protected function setStyleVars($odf,$data)
• Parameters:
  • $odf
  • $data
    • Default Value: null

Inherited Methods

action_main()

This protected method is inherited from I2CE_PageActionRelationship->action_main()

getOrdering()

This protected method is inherited from I2CE_PageActionRelationship->getOrdering()

loadData()

This protected method is inherited from I2CE_PageActionRelationship->loadData()

loadPrimary()

This protected method is inherited from I2CE_PageActionRelationship->loadPrimary()

loadRelationship()

This protected method is inherited from I2CE_PageActionRelationship->loadRelationship()

sortIterator()

This protected method is inherited from I2CE_PageActionRelationship->sortIterator()

Inherited Variables

$formRelationship

Theis protected variable is inherited from I2CE_PageActionRelationship->$formRelationship

$primObj

Theis protected variable is inherited from I2CE_PageActionRelationship->$primObj

$data

Theis protected variable is inherited from I2CE_PageActionRelationship->$data