Class: I2CE FormRelationship: Difference between revisions

From IHRIS Wiki
No edit summary
No edit summary
Line 2: Line 2:
*Extends the class: [[Class: I2CE_Fuzzy | I2CE_Fuzzy]].
*Extends the class: [[Class: I2CE_Fuzzy | I2CE_Fuzzy]].
*Location: Part of the module [[I2CE Module List#formRelationships|formRelationships]] in the package [https://launchpad.net/i2ce I2CE]
*Location: Part of the module [[I2CE Module List#formRelationships|formRelationships]] in the package [https://launchpad.net/i2ce I2CE]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.1-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php]
*Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php#L29 modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php] on line 29
*Author: Carl Leitner <litlfred@ibiblio.org>
*Author: Carl Leitner <litlfred@ibiblio.org>
I2CE_CustomRelationship
I2CE_CustomRelationship
==Variables==
==Variables==
===$primaryForm===
===$primaryForm===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php#L33 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php] on line 33
*Type: protected $primaryForm
*Type: protected $primaryForm


===$primaryFormName===
===$primaryFormName===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php#L34 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php] on line 34
*Type: protected $primaryFormName
*Type: protected $primaryFormName


===$parentFormNames===
===$parentFormNames===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php#L35 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php] on line 35
*Type: protected $parentFormNames
*Type: protected $parentFormNames


===$formConfigs===
===$formConfigs===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php#L36 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php] on line 36
*Type: protected $formConfigs
*Type: protected $formConfigs


===$relationship===
===$relationship===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php#L37 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php] on line 37
*Type: protected $relationship
*Type: protected $relationship


===$relConfig===
===$relConfig===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php#L38 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php] on line 38
*Type: protected $relConfig
*Type: protected $relConfig


===$form_reference===
===$form_reference===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php#L39 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php] on line 39
*Type: protected $form_reference
*Type: protected $form_reference


===$operands===
===$operands===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php#L182 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php] on line 182
*Type: static protected $operands
*Type: static protected $operands


==Methods==
==Methods==
===__construct()===
===__construct()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php#L46 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php] on line 46
*Signature: public function __construct($relationship,$form_reference,$relationship_base)
*Signature: public function __construct($relationship,$form_reference,$relationship_base)
*Parameters:
*Parameters:
Line 38: Line 47:
**$relationship_base  
**$relationship_base  
===_getLimitingFields()===
===_getLimitingFields()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php#L197 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php] on line 197
*Signature: protected function _getLimitingFields($whereConfig,$limiting_fields)
*Signature: protected function _getLimitingFields($whereConfig,$limiting_fields)
*Parameters:
*Parameters:
Line 43: Line 53:
**&$limiting_fields  
**&$limiting_fields  
===generateWhereClause()===
===generateWhereClause()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php#L224 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php] on line 224
*Signature: public function generateWhereClause($formName)
*Signature: public function generateWhereClause($formName)
*Parameters:
*Parameters:
**$formName  
**$formName  
===getForm()===
===getForm()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php#L62 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php] on line 62
*Signature: public function getForm($formname)
*Signature: public function getForm($formname)
*Parameters:
*Parameters:
**$formname  
**$formname  
===getFormConfig()===
===getFormConfig()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php#L100 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php] on line 100
*Signature: public function getFormConfig($form)
*Signature: public function getFormConfig($form)
*Parameters:
*Parameters:
Line 56: Line 69:
***Default Value: null
***Default Value: null
===getFormNames()===
===getFormNames()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php#L139 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php] on line 139
*Signature: public function getFormNames()
*Signature: public function getFormNames()
===getForms()===
===getForms()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php#L88 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php] on line 88
*Signature: protected function getForms($config,$formConfigs,$parentForms,$parent_form_name)
*Signature: protected function getForms($config,$formConfigs,$parentForms,$parent_form_name)
*Parameters:
*Parameters:
Line 65: Line 80:
**$parent_form_name  
**$parent_form_name  
===getFunctionDetails()===
===getFunctionDetails()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php#L157 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php] on line 157
*Signature: public function getFunctionDetails($function)
*Signature: public function getFunctionDetails($function)
*Parameters:
*Parameters:
**$function  
**$function  
===getJoin()===
===getJoin()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php#L334 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php] on line 334
*Signature: public function getJoin($formName)
*Signature: public function getJoin($formName)
*Parameters:
*Parameters:
**$formName  
**$formName  
===getLimitingFields()===
===getLimitingFields()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php#L184 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php] on line 184
*Signature: public function getLimitingFields($formName)
*Signature: public function getLimitingFields($formName)
*Parameters:
*Parameters:
**$formName  
**$formName  
===getParentFormNames()===
===getParentFormNames()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php#L112 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php] on line 112
*Signature: public function getParentFormNames($formname)
*Signature: public function getParentFormNames($formname)
*Parameters:
*Parameters:
Line 82: Line 101:
***Default Value: null
***Default Value: null
===getPrimaryForm()===
===getPrimaryForm()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php#L126 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php] on line 126
*Signature: public function getPrimaryForm()
*Signature: public function getPrimaryForm()
===getPrimaryFormName()===
===getPrimaryFormName()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php#L130 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php] on line 130
*Signature: public function getPrimaryFormName()
*Signature: public function getPrimaryFormName()
===getReferencedForm()===
===getReferencedForm()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php#L146 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php] on line 146
*Signature: public function getReferencedForm($form)
*Signature: public function getReferencedForm($form)
*Parameters:
*Parameters:
**$form  
**$form  
===getReferenedForm()===
===getReferenedForm()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php#L252 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php] on line 252
*Signature: public function getReferenedForm($form)
*Signature: public function getReferenedForm($form)
*Parameters:
*Parameters:
Line 95: Line 118:
===getRequiredForms()===
===getRequiredForms()===
Gets the forms required by the relationship
Gets the forms required by the relationship
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php#L77 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php] on line 77
*Signature: public function getRequiredForms()
*Signature: public function getRequiredForms()
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>of string
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>of string
===isPrimaryFormName()===
===isPrimaryFormName()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php#L133 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php] on line 133
*Signature: public function isPrimaryFormName($formname)
*Signature: public function isPrimaryFormName($formname)
*Parameters:
*Parameters:
**$formname  
**$formname  
===joinOn_child()===
===joinOn_child()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php#L277 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php] on line 277
*Signature: protected function joinOn_child($childForm,$joinData)
*Signature: protected function joinOn_child($childForm,$joinData)
*Parameters:
*Parameters:
Line 107: Line 133:
**$joinData  
**$joinData  
===joinOn_child_field()===
===joinOn_child_field()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php#L285 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php] on line 285
*Signature: protected function joinOn_child_field($childForm,$joinData)
*Signature: protected function joinOn_child_field($childForm,$joinData)
*Parameters:
*Parameters:
Line 112: Line 139:
**$joinData  
**$joinData  
===joinOn_fields()===
===joinOn_fields()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php#L314 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php] on line 314
*Signature: protected function joinOn_fields($childForm,$joinData)
*Signature: protected function joinOn_fields($childForm,$joinData)
*Parameters:
*Parameters:
Line 117: Line 145:
**$joinData  
**$joinData  
===joinOn_ids()===
===joinOn_ids()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php#L263 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php] on line 263
*Signature: protected function joinOn_ids($childForm,$joinData)
*Signature: protected function joinOn_ids($childForm,$joinData)
*Parameters:
*Parameters:
Line 122: Line 151:
**$joinData  
**$joinData  
===joinOn_parent()===
===joinOn_parent()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php#L270 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php] on line 270
*Signature: protected function joinOn_parent($childForm,$joinData)
*Signature: protected function joinOn_parent($childForm,$joinData)
*Parameters:
*Parameters:
Line 127: Line 157:
**$joinData  
**$joinData  
===joinOn_parent_field()===
===joinOn_parent_field()===
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php#L299 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_FormRelationship.php] on line 299
*Signature: protected function joinOn_parent_field($childForm,$joinData)
*Signature: protected function joinOn_parent_field($childForm,$joinData)
*Parameters:
*Parameters:

Revision as of 08:50, 10 November 2009

This article describes the class I2CE_FormRelationship.

I2CE_CustomRelationship

Variables

$primaryForm

$primaryFormName

$parentFormNames

$formConfigs

$relationship

$relConfig

$form_reference

$operands

Methods

__construct()

_getLimitingFields()

generateWhereClause()

getForm()

getFormConfig()

getFormNames()

getForms()

getFunctionDetails()

getJoin()

getLimitingFields()

getParentFormNames()

getPrimaryForm()

getPrimaryFormName()

getReferencedForm()

getReferenedForm()

getRequiredForms()

Gets the forms required by the relationship

isPrimaryFormName()

joinOn_child()

joinOn_child_field()

joinOn_fields()

joinOn_ids()

joinOn_parent()

joinOn_parent_field()

Inherited Methods

_hasMethod()

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

Inherited Fuzzy Methods

userMessage()

This method is inherited from I2CE_Fuzzy->userMessage()