|
|
| (29 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| This article desrcibes the class '''I2CE_Swiss_FormRelationship_Joins'''which extends the class [[Class: I2CE_Swiss_FormRelationship_Base | I2CE_Swiss_FormRelationship_Base]]
| | #REDIRECT [[Class: I2CE_Swiss_FormRelationship_Joins (4.1.7)]] |
| It is contained in the module [[iHRIS Module List#formRelationships|formRelationships]] in the package [https://launchpad.net/i2ce I2CE]
| |
| The class is defined in the file: [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.0-release/files/head:modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship_Joins.php modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship_Joins.php]
| |
| I2CE_SwissConfig_FormRelationship_Joins
| |
| @package I2CE
| |
| @subpackage Core
| |
| @author Carl Leitner <litlfred@ibiblio.org>
| |
| @version 2.1
| |
| @access public
| |
| ==Methods==
| |
| ===displayExistingJoins()===
| |
| Displays the existing joined forms
| |
| @param mixed $configPath
| |
| *Signature: protected function displayExistingJoins($action,$joins,$contentNode,$transient_options)
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean] true on success
| |
| Parameters:
| |
| *$action
| |
| *$joins
| |
| * [http://www.php.net/manual/en/class.domnode.php domnode] $contentNode
| |
| *$transient_options
| |
| ===displayJoinMenu()===
| |
| Add in the UI to select the joinable forms for the specified form
| |
| *Signature: protected function displayJoinMenu($action,$relatedForms,$contentNode)
| |
| *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean] true on success
| |
| Parameters:
| |
| *$action
| |
| *$relatedForms
| |
| * [http://www.php.net/manual/en/class.domnode.php domnode] $contentNode
| |
| ===displayValues()===
| |
| *Signature: public function displayValues($content_node,$transient_options,$action)
| |
| Parameters:
| |
| *$content_node
| |
| *$transient_options
| |
| *$action
| |
| ===getChildType()===
| |
| *Signature: public function getChildType($child)
| |
| Parameters:
| |
| *$child
| |
| ===getRelatedForms()===
| |
| Gets the data on forms related to the specified form
| |
| *Signature: protected function getRelatedForms()
| |
| *Returns: [http://www.php.net/manual/en/language.types.array.php array] with four keys: 'child','parent', 'parent_field','child_field' each of which has a value an array.
| |
| the first two have arrays with keys forms and value 'true'. The later two have arrays with keys forms
| |
| and value an array with keys 'field' and 'formClass'
| |
| ===processValues()===
| |
| Update config for given values
| |
| *Signature: public function processValues($vals)
| |
| *Returns: true on sucess
| |
| Parameters:
| |
| * [http://www.php.net/manual/en/language.types.array.php array] $vals<br/>An array of values (presumably from $_POST) to update magic data from
| |
| ==Inherited Variables==
| |
| ===$swissRelationship===
| |
| Theis protected variable is inherited from [[Class: I2CE_Swiss_FormRelationship_Base#$swissRelationship | I2CE_Swiss_FormRelationship_Base->$swissRelationship]]
| |
| | |
| ===$swissForms===
| |
| Theis protected variable is inherited from [[Class: I2CE_Swiss_FormRelationship_Base#$swissForms | I2CE_Swiss_FormRelationship_Base->$swissForms]]
| |
| | |
| ===$name===
| |
| Theis protected variable is inherited from [[Class: I2CE_Swiss#$name | I2CE_Swiss->$name]]
| |
| | |
| ===$path===
| |
| Theis protected variable is inherited from [[Class: I2CE_Swiss#$path | I2CE_Swiss->$path]]
| |
| | |
| ===$parent===
| |
| Theis protected variable is inherited from [[Class: I2CE_Swiss#$parent | I2CE_Swiss->$parent]]
| |
| | |
| ===$page===
| |
| Theis protected variable is inherited from [[Class: I2CE_Swiss#$page | I2CE_Swiss->$page]]
| |
| | |
| ===$template===
| |
| Theis protected variable is inherited from [[Class: I2CE_Swiss#$template | I2CE_Swiss->$template]]
| |
| | |
| ===$children===
| |
| Theis protected variable is inherited from [[Class: I2CE_Swiss#$children | I2CE_Swiss->$children]]
| |
| ==Inherited Fuzzy Methods==
| |
| ===userMessage()===
| |
| This method is inherited from [[Class: I2CE_Fuzzy#userMessage() | I2CE_Fuzzy->userMessage()]]
| |
| | |
| | |
| [[Category:Class Documentation]]
| |
