Class: I2CE Swiss FormRelationship Joins: Difference between revisions
No edit summary |
No edit summary |
||
Line 2: | Line 2: | ||
*Extends the class: [[Class: I2CE_Swiss_FormRelationship_Base | I2CE_Swiss_FormRelationship_Base]]. | *Extends the class: [[Class: I2CE_Swiss_FormRelationship_Base | I2CE_Swiss_FormRelationship_Base]]. | ||
*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. | *Source: Defined in the file [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship_Joins.php#L29 modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship_Joins.php] on line 29 | ||
*Author: Carl Leitner <litlfred@ibiblio.org> | *Author: Carl Leitner <litlfred@ibiblio.org> | ||
I2CE_SwissConfig_FormRelationship_Joins | I2CE_SwissConfig_FormRelationship_Joins | ||
Line 8: | Line 8: | ||
===displayExistingJoins()=== | ===displayExistingJoins()=== | ||
Displays the existing joined forms @param mixed $configPath | Displays the existing joined forms @param mixed $configPath | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship_Joins.php#L129 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship_Joins.php] on line 129 | |||
*Signature: protected function displayExistingJoins($action,$joins,$contentNode,$transient_options) | *Signature: protected function displayExistingJoins($action,$joins,$contentNode,$transient_options) | ||
*Parameters: | *Parameters: | ||
Line 17: | Line 18: | ||
===displayJoinMenu()=== | ===displayJoinMenu()=== | ||
Add in the UI to select the joinable forms for the specified form | Add in the UI to select the joinable forms for the specified form | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship_Joins.php#L162 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship_Joins.php] on line 162 | |||
*Signature: protected function displayJoinMenu($action,$relatedForms,$contentNode) | *Signature: protected function displayJoinMenu($action,$relatedForms,$contentNode) | ||
*Parameters: | *Parameters: | ||
Line 24: | Line 26: | ||
*Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]<br/>true on success | *Returns: [http://www.php.net/manual/en/language.types.boolean.php boolean ]<br/>true on success | ||
===displayValues()=== | ===displayValues()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship_Joins.php#L92 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship_Joins.php] on line 92 | |||
*Signature: public function displayValues($content_node,$transient_options,$action) | *Signature: public function displayValues($content_node,$transient_options,$action) | ||
*Parameters: | *Parameters: | ||
Line 30: | Line 33: | ||
**$action | **$action | ||
===getChildType()=== | ===getChildType()=== | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship_Joins.php#L32 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship_Joins.php] on line 32 | |||
*Signature: public function getChildType($child) | *Signature: public function getChildType($child) | ||
*Parameters: | *Parameters: | ||
Line 35: | Line 39: | ||
===getRelatedForms()=== | ===getRelatedForms()=== | ||
Gets the data on forms related to the specified form | Gets the data on forms related to the specified form | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship_Joins.php#L224 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship_Joins.php] on line 224 | |||
*Signature: protected function getRelatedForms() | *Signature: protected function getRelatedForms() | ||
*Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>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' | *Returns: [http://www.php.net/manual/en/language.types.array.php array ]<br/>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()=== | ===processValues()=== | ||
Update config for given values | Update config for given values | ||
*Defined in [http://bazaar.launchpad.net/~intrahealth+informatics/i2ce/4.0.2-release/annotate/head:/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship_Joins.php#L42 i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship_Joins.php] on line 42 | |||
*Signature: public function processValues($vals) | *Signature: public function processValues($vals) | ||
*Parameters: | *Parameters: |
Revision as of 10:19, 10 November 2009
This article describes the class I2CE_Swiss_FormRelationship_Joins.
- Extends the class: I2CE_Swiss_FormRelationship_Base.
- Location: Part of the module formRelationships in the package I2CE
- Source: Defined in the file modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship_Joins.php on line 29
- Author: Carl Leitner <litlfred@ibiblio.org>
I2CE_SwissConfig_FormRelationship_Joins
Methods
displayExistingJoins()
Displays the existing joined forms @param mixed $configPath
- Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship_Joins.php on line 129
- Signature: protected function displayExistingJoins($action,$joins,$contentNode,$transient_options)
- Parameters:
- $action
- $joins
- DOMNode $contentNode
- $transient_options
- Returns: boolean
true on success
displayJoinMenu()
Add in the UI to select the joinable forms for the specified form
- Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship_Joins.php on line 162
- Signature: protected function displayJoinMenu($action,$relatedForms,$contentNode)
- Parameters:
- $action
- $relatedForms
- DOMNode $contentNode
- Returns: boolean
true on success
displayValues()
- Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship_Joins.php on line 92
- Signature: public function displayValues($content_node,$transient_options,$action)
- Parameters:
- $content_node
- $transient_options
- $action
getChildType()
- Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship_Joins.php on line 32
- Signature: public function getChildType($child)
- Parameters:
- $child
getRelatedForms()
Gets the data on forms related to the specified form
- Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship_Joins.php on line 224
- Signature: protected function getRelatedForms()
- Returns: 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
- Defined in i2ce/modules/Forms/modules/FormRelationship/lib/I2CE_Swiss_FormRelationship_Joins.php on line 42
- Signature: public function processValues($vals)
- Parameters:
- array $vals
An array of values (presumably from $_POST) to update magic data from
- array $vals
- Returns: true
on sucess
Inherited Methods
displayOptions()
This public method is inherited from I2CE_Swiss_FormRelationship_Base->displayOptions()
getAjaxJSNodes()
This public method is inherited from I2CE_Swiss_FormRelationship_Base->getAjaxJSNodes()
getExistingFormNames()
This public method is inherited from I2CE_Swiss_FormRelationship_Base->getExistingFormNames()
getExistingSwissForms()
This public method is inherited from I2CE_Swiss_FormRelationship_Base->getExistingSwissForms()
getRelationship()
This public method is inherited from I2CE_Swiss_FormRelationship_Base->getRelationship()
getRelationshipBase()
This public method is inherited from I2CE_Swiss_FormRelationship_Base->getRelationshipBase()
getRelationships()
This public method is inherited from I2CE_Swiss_FormRelationship_Base->getRelationships()
getSwissForm()
This public method is inherited from I2CE_Swiss_FormRelationship_Base->getSwissForm()
initializeDisplay()
This public method is inherited from I2CE_Swiss_FormRelationship_Base->initializeDisplay()
getAncestorByClass()
This protected method is inherited from I2CE_Swiss_FormRelationship_Base->getAncestorByClass()
__construct()
This public method is inherited from I2CE_Swiss->__construct()
addAjaxLink()
This public method is inherited from I2CE_Swiss->addAjaxLink()
addLink()
This public method is inherited from I2CE_Swiss->addLink()
count()
This public method is inherited from I2CE_Swiss->count()
current()
This public method is inherited from I2CE_Swiss->current()
display()
This public method is inherited from I2CE_Swiss->display()
getAttribute()
This public method is inherited from I2CE_Swiss->getAttribute()
getChild()
This public method is inherited from I2CE_Swiss->getChild()
getChildNames()
This public method is inherited from I2CE_Swiss->getChildNames()
getDescription()
This public method is inherited from I2CE_Swiss->getDescription()
getDisplayName()
This public method is inherited from I2CE_Swiss->getDisplayName()
getFactory()
This public method is inherited from I2CE_Swiss->getFactory()
getField()
This public method is inherited from I2CE_Swiss->getField()
getKeys()
This public method is inherited from I2CE_Swiss->getKeys()
getLocale()
This public method is inherited from I2CE_Swiss->getLocale()
getName()
This public method is inherited from I2CE_Swiss->getName()
getPage()
This public method is inherited from I2CE_Swiss->getPage()
getParent()
This public method is inherited from I2CE_Swiss->getParent()
getPath()
This public method is inherited from I2CE_Swiss->getPath()
getStatus()
This public method is inherited from I2CE_Swiss->getStatus()
getStorage()
This public method is inherited from I2CE_Swiss->getStorage()
getURLQueryString()
This public method is inherited from I2CE_Swiss->getURLQueryString()
getURLRoot()
This public method is inherited from I2CE_Swiss->getURLRoot()
hasAttribute()
This public method is inherited from I2CE_Swiss->hasAttribute()
hasField()
This public method is inherited from I2CE_Swiss->hasField()
hasParent()
This public method is inherited from I2CE_Swiss->hasParent()
humanText()
This public method is inherited from I2CE_Swiss->humanText()
key()
This public method is inherited from I2CE_Swiss->key()
next()
This public method is inherited from I2CE_Swiss->next()
postprocessDisplay()
This public method is inherited from I2CE_Swiss->postprocessDisplay()
prefixName()
This public method is inherited from I2CE_Swiss->prefixName()
renameInputs()
This public method is inherited from I2CE_Swiss->renameInputs()
rewind()
This public method is inherited from I2CE_Swiss->rewind()
setField()
This public method is inherited from I2CE_Swiss->setField()
setPage()
This public method is inherited from I2CE_Swiss->setPage()
setTranslatableField()
This public method is inherited from I2CE_Swiss->setTranslatableField()
updateValues()
This public method is inherited from I2CE_Swiss->updateValues()
valid()
This public method is inherited from I2CE_Swiss->valid()
_getChild()
This protected method is inherited from I2CE_Swiss->_getChild()
addAjaxOptionMenu()
This protected method is inherited from I2CE_Swiss->addAjaxOptionMenu()
addOptionMenu()
This protected method is inherited from I2CE_Swiss->addOptionMenu()
changeClassOnNodes()
This protected method is inherited from I2CE_Swiss->changeClassOnNodes()
createIfNotExists()
This protected method is inherited from I2CE_Swiss->createIfNotExists()
validateValues()
This protected method is inherited from I2CE_Swiss->validateValues()
_hasMethod()
This public method is inherited from I2CE_Fuzzy->_hasMethod()
Inherited Variables
$swissRelationship
Theis protected variable is inherited from I2CE_Swiss_FormRelationship_Base->$swissRelationship
$swissForms
Theis protected variable is inherited from I2CE_Swiss_FormRelationship_Base->$swissForms
$name
Theis protected variable is inherited from I2CE_Swiss->$name
$path
Theis protected variable is inherited from I2CE_Swiss->$path
$parent
Theis protected variable is inherited from I2CE_Swiss->$parent
$page
Theis protected variable is inherited from I2CE_Swiss->$page
$template
Theis protected variable is inherited from I2CE_Swiss->$template
$children
Theis protected variable is inherited from I2CE_Swiss->$children
Inherited Fuzzy Methods
userMessage()
This method is inherited from I2CE_Fuzzy->userMessage()