|
|
| Line 1: |
Line 1: |
| This article describes the class ''I2CE_FormRelationship''.
| | #REDIRECT [[Class: I2CE_FormRelationship (4.0.3)]] |
| *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]
| |
| *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>
| |
| I2CE_CustomRelationship
| |
| ==Variables==
| |
| ===$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
| |
| | |
| ===$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
| |
| | |
| ===$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
| |
| | |
| ===$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
| |
| | |
| ===$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
| |
| | |
| ===$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
| |
| | |
| ===$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
| |
| | |
| ===$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
| |
| | |
| ==Methods==
| |
| ===__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)
| |
| *Parameters:
| |
| ** [http://www.php.net/manual/en/language.types.string.php string ] $relationship
| |
| ** [http://www.php.net/manual/en/language.pseudo-types.php callback ] $form_reference
| |
| **$relationship_base
| |
| ===_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)
| |
| *Parameters:
| |
| **$whereConfig
| |
| **&$limiting_fields
| |
| ===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)
| |
| *Parameters:
| |
| **$formName
| |
| ===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)
| |
| *Parameters:
| |
| **$formname
| |
| ===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)
| |
| *Parameters:
| |
| **$form
| |
| ***Default Value: null
| |
| ===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()
| |
| ===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)
| |
| *Parameters:
| |
| **$config
| |
| **&$formConfigs
| |
| **&$parentForms
| |
| **$parent_form_name
| |
| ===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)
| |
| *Parameters:
| |
| **$function
| |
| ===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)
| |
| *Parameters:
| |
| **$formName
| |
| ===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)
| |
| *Parameters:
| |
| **$formName
| |
| ===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)
| |
| *Parameters:
| |
| **$formname
| |
| ***Default Value: null
| |
| ===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()
| |
| ===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()
| |
| ===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)
| |
| *Parameters:
| |
| **$form
| |
| ===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)
| |
| *Parameters:
| |
| **$form
| |
| ===getRequiredForms()===
| |
| 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()
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>of string
| |
| ===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)
| |
| *Parameters:
| |
| **$formname
| |
| ===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)
| |
| *Parameters:
| |
| **$childForm
| |
| **$joinData
| |
| ===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)
| |
| *Parameters:
| |
| **$childForm
| |
| **$joinData
| |
| ===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)
| |
| *Parameters:
| |
| **$childForm
| |
| **$joinData
| |
| ===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)
| |
| *Parameters:
| |
| **$childForm
| |
| **$joinData
| |
| ===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)
| |
| *Parameters:
| |
| **$childForm
| |
| **$joinData
| |
| ===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)
| |
| *Parameters:
| |
| **$childForm
| |
| **$joinData
| |
| ==Inherited Methods==
| |
| ===_hasMethod()===
| |
| This public method is inherited from [[Class: I2CE_Fuzzy#_hasMethod() | I2CE_Fuzzy->_hasMethod()]]
| |
| ==Inherited Fuzzy Methods==
| |
| ===userMessage()===
| |
| This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
